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

the InitConstraintValues class. More...

#include <OSOption.h>

+ Collaboration diagram for InitConstraintValues:

Public Member Functions

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

Public Attributes

int numberOfCon
 number of <con> children More...
 
InitConValue ** con
 initial value for each constraint More...
 

Detailed Description

the InitConstraintValues 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 2822 of file OSOption.h.

Constructor & Destructor Documentation

◆ InitConstraintValues()

InitConstraintValues::InitConstraintValues ( )

Default constructor.

◆ ~InitConstraintValues()

InitConstraintValues::~InitConstraintValues ( )

Class destructor.

Member Function Documentation

◆ IsEqual()

bool InitConstraintValues::IsEqual ( InitConstraintValues that)

A function to check for the equality of two objects.

◆ setRandom()

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

◆ setCon() [1/3]

bool InitConstraintValues::setCon ( int  numberOfCon,
InitConValue **  con 
)

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

Parameters
numberOfConnumber of <con> elements to be set
conthe array of <con> elements that are to be set

◆ setCon() [2/3]

bool InitConstraintValues::setCon ( int  numberOfCon,
InitConValue **  con,
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

◆ setCon() [3/3]

bool InitConstraintValues::setCon ( int  numberOfCon,
int *  idx,
double *  value,
std::string *  name 
)

Another alternative signature for this function.

Parameters
numberOfConnumber of <con> elements to be set
idxthe array of indices
valuethe array of corresponding values
namethe array of constraint names

◆ addCon() [1/2]

bool InitConstraintValues::addCon ( int  idx,
double  value 
)

A function to add a <con> element.

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

◆ addCon() [2/2]

bool InitConstraintValues::addCon ( int  numberOfCon,
InitConValue **  con 
)

Alternative signature for this function.

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

Parameters
numberOfConnumber of <con> elements to be set
objthe array of <con> elements that are to be set

Member Data Documentation

◆ numberOfCon

int InitConstraintValues::numberOfCon

number of <con> children

Definition at line 2827 of file OSOption.h.

◆ con

InitConValue** InitConstraintValues::con

initial value for each constraint

Definition at line 2830 of file OSOption.h.


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