OS  2.10.2
Public Member Functions | Public Attributes | List of all members
InitObjectiveValues Class Reference

the InitObjectiveValues class. More...

#include <OSOption.h>

+ Collaboration diagram for InitObjectiveValues:

Public Member Functions

 InitObjectiveValues ()
 Default constructor. More...
 
 ~InitObjectiveValues ()
 Class destructor. More...
 
bool IsEqual (InitObjectiveValues *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 (InitObjectiveValues *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setObj (int numberOfObj, InitObjValue **obj)
 A function to set an array of <obj> elements. More...
 
bool setObj (int numberOfObj, InitObjValue **obj, ENUM_COMBINE_ARRAYS disp)
 Alternative signature for this function. More...
 
bool setObj (int numberOfObj, int *idx, double *value, std::string *name)
 Another alternative signature for this function. More...
 
bool addObj (int idx, double value)
 A function to add a <obj> element. More...
 
bool addObj (int numberOfObj, InitObjValue **obj)
 Alternative signature for this function. More...
 

Public Attributes

int numberOfObj
 number of <obj> children More...
 
InitObjValue ** obj
 initial value for each objective More...
 

Detailed Description

the InitObjectiveValues 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 2241 of file OSOption.h.

Constructor & Destructor Documentation

◆ InitObjectiveValues()

InitObjectiveValues::InitObjectiveValues ( )

Default constructor.

◆ ~InitObjectiveValues()

InitObjectiveValues::~InitObjectiveValues ( )

Class destructor.

Member Function Documentation

◆ IsEqual()

bool InitObjectiveValues::IsEqual ( InitObjectiveValues that)

A function to check for the equality of two objects.

◆ setRandom()

bool InitObjectiveValues::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)

◆ deepCopyFrom()

bool InitObjectiveValues::deepCopyFrom ( InitObjectiveValues 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

◆ setObj() [1/3]

bool InitObjectiveValues::setObj ( int  numberOfObj,
InitObjValue **  obj 
)

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

Parameters
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set

◆ setObj() [2/3]

bool InitObjectiveValues::setObj ( int  numberOfObj,
InitObjValue **  obj,
ENUM_COMBINE_ARRAYS  disp 
)

Alternative signature for this function.

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set
dispmethod of disposition if previous data exist

◆ setObj() [3/3]

bool InitObjectiveValues::setObj ( int  numberOfObj,
int *  idx,
double *  value,
std::string *  name 
)

Another alternative signature for this function.

Parameters
numberOfObjnumber of <obj> elements to be set
idxthe array of indices
valuethe array of corresponding values
namethe array of objective names

◆ addObj() [1/2]

bool InitObjectiveValues::addObj ( int  idx,
double  value 
)

A function to add a <obj> element.

Parameters
idxthe index of the objective to be given an initial value
valuethe initial value to be added

◆ addObj() [2/2]

bool InitObjectiveValues::addObj ( int  numberOfObj,
InitObjValue **  obj 
)

Alternative signature for this function.

A function to add an array of <obj> elements simultaneously

Parameters
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set

Member Data Documentation

◆ numberOfObj

int InitObjectiveValues::numberOfObj

number of <obj> children

Definition at line 2246 of file OSOption.h.

◆ obj

InitObjValue** InitObjectiveValues::obj

initial value for each objective

Definition at line 2249 of file OSOption.h.


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