My Project
VariableOption Class Reference

the VariableOption class. More...

#include <OSOption.h>

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 2096 of file OSOption.h.

Constructor & Destructor Documentation

◆ VariableOption()

VariableOption::VariableOption ( )

Default constructor.

Definition at line 740 of file OSOption.cpp.

◆ ~VariableOption()

VariableOption::~VariableOption ( )

Class destructor.

Definition at line 754 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool VariableOption::IsEqual ( VariableOption * that)

A function to check for the equality of two objects.

Definition at line 10632 of file OSOption.cpp.

◆ setRandom()

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

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif 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.

◆ deepCopyFrom()

bool VariableOption::deepCopyFrom ( VariableOption * that)

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

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

Definition at line 13730 of file OSOption.cpp.

◆ setOther()

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

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

Parameters
numberOfOptionsnumber of <other> elements to be set
otherthe array of <other> elements that are to be set

Definition at line 5994 of file OSOption.cpp.

◆ addOther()

bool VariableOption::addOther ( OtherVariableOption * other)

A function to add an <other> element.

Parameters
otherthe content of the <other> element to be added

Definition at line 6064 of file OSOption.cpp.

Member Data Documentation

◆ numberOfOtherVariableOptions

int VariableOption::numberOfOtherVariableOptions

number of <other> child elements

Definition at line 2101 of file OSOption.h.

◆ initialVariableValues

InitVariableValues* VariableOption::initialVariableValues

initial values for the variables

Definition at line 2104 of file OSOption.h.

◆ initialVariableValuesString

InitVariableValuesString* VariableOption::initialVariableValuesString

initial values for string-valued variables

Definition at line 2107 of file OSOption.h.

◆ initialBasisStatus

BasisStatus* VariableOption::initialBasisStatus

initial basis information

Definition at line 2110 of file OSOption.h.

◆ integerVariableBranchingWeights

IntegerVariableBranchingWeights* VariableOption::integerVariableBranchingWeights

branching weights for integer variables

Definition at line 2113 of file OSOption.h.

◆ sosVariableBranchingWeights

SOSVariableBranchingWeights* VariableOption::sosVariableBranchingWeights

branching weights for SOS variables and groups

Definition at line 2116 of file OSOption.h.

◆ other

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: