My Project
InitConstraintValues Class Reference

the InitConstraintValues class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

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

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.

Definition at line 1000 of file OSOption.cpp.

◆ ~InitConstraintValues()

InitConstraintValues::~InitConstraintValues ( )

Class destructor.

Definition at line 1009 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InitConstraintValues::IsEqual ( InitConstraintValues * that)

A function to check for the equality of two objects.

Definition at line 11766 of file OSOption.cpp.

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

Definition at line 13106 of file OSOption.cpp.

◆ 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

Definition at line 14194 of file OSOption.cpp.

◆ 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

Definition at line 6781 of file OSOption.cpp.

◆ setCon() [2/3]

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

Alternative signature for this function.

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

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set
dispmethod of disposition if previous data exist
numberOfConnumber of <con> elements to be set
conthe array of <con> elements that are to be set
dispmethod of disposition if previous data exist

Definition at line 6819 of file OSOption.cpp.

◆ 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

Definition at line 6864 of file OSOption.cpp.

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

Definition at line 6897 of file OSOption.cpp.

◆ addCon() [2/2]

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

Alternative signature for this function.

A function to add several <con> elements.

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

Definition at line 6940 of file OSOption.cpp.

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