VariableOption Class Reference

the VariableOption class. More...

#include <OSOption.h>

Collaboration diagram for VariableOption:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 VariableOption ()
 Default constructor.
 ~VariableOption ()
 Class destructor.
bool IsEqual (VariableOption *that)
 A function to check for the equality of two objects.
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class.
bool deepCopyFrom (VariableOption *that)
 A function to make a deep copy of an instance of this class.
bool setOther (int numberOfOptions, OtherVariableOption **other)
 A function to set an array of <other> elements.
bool addOther (OtherVariableOption *other)
 A function to add an <other> element.

Public Attributes

int numberOfOtherVariableOptions
 number of <other> child elements
InitVariableValuesinitialVariableValues
 initial values for the variables
InitVariableValuesStringinitialVariableValuesString
 initial values for string-valued variables
BasisStatusinitialBasisStatus
 initial basis information
IntegerVariableBranchingWeightsintegerVariableBranchingWeights
 branching weights for integer variables
SOSVariableBranchingWeightssosVariableBranchingWeights
 branching weights for SOS variables and groups
OtherVariableOption ** other
 other variable options

Detailed Description

the VariableOption class.

Author:
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 21/07/2008
Since:
OS 1.1
Remarks:
A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 2097 of file OSOption.h.


Constructor & Destructor Documentation

VariableOption::VariableOption (  ) 

Default constructor.

Definition at line 740 of file OSOption.cpp.

VariableOption::~VariableOption (  ) 

Class destructor.

Definition at line 754 of file OSOption.cpp.


Member Function Documentation

bool VariableOption::IsEqual ( VariableOption that  ) 

A function to check for the equality of two objects.

Definition at line 10629 of file OSOption.cpp.

bool VariableOption::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 12605 of file OSOption.cpp.

bool VariableOption::deepCopyFrom ( VariableOption that  ) 

A function to make a deep copy of an instance of this class.

Parameters:
that,: the instance from which information is to be copied
Returns:
whether the copy was created successfully

Definition at line 13726 of file OSOption.cpp.

bool VariableOption::setOther ( int  numberOfOptions,
OtherVariableOption **  other 
)

A function to set an array of <other> elements.

Parameters:
numberOfOptions,: number of <other> elements to be set
other,: the array of <other> elements that are to be set

Definition at line 5994 of file OSOption.cpp.

bool VariableOption::addOther ( OtherVariableOption other  ) 

A function to add an <other> element.

Parameters:
other,: the content of the <other> element to be added

Definition at line 6064 of file OSOption.cpp.


Member Data Documentation

number of <other> child elements

Definition at line 2102 of file OSOption.h.

initial values for the variables

Definition at line 2105 of file OSOption.h.

initial values for string-valued variables

Definition at line 2108 of file OSOption.h.

initial basis information

Definition at line 2111 of file OSOption.h.

branching weights for integer variables

Definition at line 2114 of file OSOption.h.

branching weights for SOS variables and groups

Definition at line 2117 of file OSOption.h.

other variable options

Definition at line 2120 of file OSOption.h.


The documentation for this class was generated from the following files:

Generated on 24 Jul 2013 by  doxygen 1.6.1