the VariableOption class. More...
#include <OSOption.h>
Public Member Functions | |
| VariableOption () | |
| Default constructor. More... | |
| ~VariableOption () | |
| Class destructor. More... | |
| bool | IsEqual (VariableOption *that) |
| A function to check for the equality of two objects. More... | |
| bool | setRandom (double density, bool conformant) |
| A function to make a random instance of this class. More... | |
| bool | deepCopyFrom (VariableOption *that) |
| A function to make a deep copy of an instance of this class. More... | |
| bool | setOther (int numberOfOptions, OtherVariableOption **other) |
| A function to set an array of <other> elements. More... | |
| bool | addOther (OtherVariableOption *other) |
| A function to add an <other> element. More... | |
Public Attributes | |
| int | numberOfOtherVariableOptions |
| number of <other> child elements More... | |
| InitVariableValues * | initialVariableValues |
| initial values for the variables More... | |
| InitVariableValuesString * | initialVariableValuesString |
| initial values for string-valued variables More... | |
| BasisStatus * | initialBasisStatus |
| initial basis information More... | |
| IntegerVariableBranchingWeights * | integerVariableBranchingWeights |
| branching weights for integer variables More... | |
| SOSVariableBranchingWeights * | sosVariableBranchingWeights |
| branching weights for SOS variables and groups More... | |
| OtherVariableOption ** | other |
| other variable options More... | |
Detailed Description
the VariableOption class.
- 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 2096 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 10632 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 12609 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 13730 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
| int VariableOption::numberOfOtherVariableOptions |
number of <other> child elements
Definition at line 2101 of file OSOption.h.
| InitVariableValues* VariableOption::initialVariableValues |
initial values for the variables
Definition at line 2104 of file OSOption.h.
| InitVariableValuesString* VariableOption::initialVariableValuesString |
initial values for string-valued variables
Definition at line 2107 of file OSOption.h.
| BasisStatus* VariableOption::initialBasisStatus |
initial basis information
Definition at line 2110 of file OSOption.h.
| IntegerVariableBranchingWeights* VariableOption::integerVariableBranchingWeights |
branching weights for integer variables
Definition at line 2113 of file OSOption.h.
| SOSVariableBranchingWeights* VariableOption::sosVariableBranchingWeights |
branching weights for SOS variables and groups
Definition at line 2116 of file OSOption.h.
| OtherVariableOption** VariableOption::other |
other variable options
Definition at line 2119 of file OSOption.h.
The documentation for this class was generated from the following files:
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp
