My Project
InitObjectiveValues Class Reference

the InitObjectiveValues class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

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

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.

Definition at line 803 of file OSOption.cpp.

◆ ~InitObjectiveValues()

InitObjectiveValues::~InitObjectiveValues ( )

Class destructor.

Definition at line 812 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InitObjectiveValues::IsEqual ( InitObjectiveValues * that)

A function to check for the equality of two objects.

Definition at line 11396 of file OSOption.cpp.

◆ 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)

Definition at line 12920 of file OSOption.cpp.

◆ 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

Definition at line 14027 of file OSOption.cpp.

◆ 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

Definition at line 6141 of file OSOption.cpp.

◆ setObj() [2/3]

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

Alternative signature for this function.

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

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set
dispmethod of disposition if previous data exist
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set
dispmethod of disposition if previous data exist

Definition at line 6179 of file OSOption.cpp.

◆ 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

Definition at line 6223 of file OSOption.cpp.

◆ 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
idxthe index of the objective to be given an initial value
valuethe inital value to be added

Definition at line 6252 of file OSOption.cpp.

◆ addObj() [2/2]

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

Alternative signature for this function.

A function to add several <obj> elements.

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
numberOfVarnumber of <obj> elements to be added
objthe array of <obj> elements that are to be added

Definition at line 6295 of file OSOption.cpp.

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 files: