OS  2.10.1
Public Member Functions | Public Attributes | List of all members
InitVariableValuesString Class Reference

the InitVariableValuesString class. More...

#include <OSOption.h>

+ Collaboration diagram for InitVariableValuesString:

Public Member Functions

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

Public Attributes

int numberOfVar
 number of children More...
 
InitVarValueString ** var
 initial value for each variable More...
 

Detailed Description

the InitVariableValuesString 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 1379 of file OSOption.h.

Constructor & Destructor Documentation

◆ InitVariableValuesString()

InitVariableValuesString::InitVariableValuesString ( )

Default constructor.

◆ ~InitVariableValuesString()

InitVariableValuesString::~InitVariableValuesString ( )

Class destructor.

Member Function Documentation

◆ IsEqual()

bool InitVariableValuesString::IsEqual ( InitVariableValuesString that)

A function to check for the equality of two objects.

◆ setRandom()

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

◆ setVar() [1/3]

bool InitVariableValuesString::setVar ( int  numberOfVar,
InitVarValueString **  var 
)

A function to set an array of elements.

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set

◆ setVar() [2/3]

bool InitVariableValuesString::setVar ( int  numberOfVar,
InitVarValueString **  var,
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

◆ setVar() [3/3]

bool InitVariableValuesString::setVar ( int  numberOfVar,
int *  idx,
std::string *  value,
std::string *  name 
)

Another alternative signature for this function.

Parameters
numberOfVarnumber of elements to be set
idxthe array of indices
valuethe array of corresponding values
namethe array of corresponding names

◆ addVar() [1/2]

bool InitVariableValuesString::addVar ( int  idx,
std::string  value 
)

A function to add a element.

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

◆ addVar() [2/2]

bool InitVariableValuesString::addVar ( int  numberOfVar,
InitVarValueString **  var 
)

Alternative signature for this function.

A function to add an array of elements simultaneously

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set

Member Data Documentation

◆ numberOfVar

int InitVariableValuesString::numberOfVar

number of children

Definition at line 1384 of file OSOption.h.

◆ var

InitVarValueString** InitVariableValuesString::var

initial value for each variable

Definition at line 1387 of file OSOption.h.


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