InitVariableValuesString Class Reference

the InitVariableValuesString class. More...

#include <OSOption.h>

Collaboration diagram for InitVariableValuesString:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

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 1266 of file OSOption.h.


Constructor & Destructor Documentation

InitVariableValuesString::InitVariableValuesString (  ) 

Default constructor.

Definition at line 503 of file OSOption.cpp.

InitVariableValuesString::~InitVariableValuesString (  ) 

Class destructor.

Definition at line 512 of file OSOption.cpp.


Member Function Documentation

bool InitVariableValuesString::IsEqual ( InitVariableValuesString that  ) 

A function to check for the equality of two objects.

Definition at line 10618 of file OSOption.cpp.

bool InitVariableValuesString::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 12370 of file OSOption.cpp.

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

A function to set an array of elements.

Parameters:
numberOfVar,: number of elements to be set
var,: the array of elements that are to be set

Definition at line 5209 of file OSOption.cpp.

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

Alternative signature for this function.

A function to set an array of elements.

Parameters:
numberOfVar,: number of elements to be set
var,: the array of elements that are to be set
disp,: method of disposition if previous data exist
numberOfVar,: number of elements to be set
var,: the array of elements that are to be set

Definition at line 5246 of file OSOption.cpp.

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

Another alternative signature for this function.

A function to set an array of elements.

Parameters:
numberOfVar,: number of elements to be set
idx,: the array of indices
value,: the array of corresponding values
name,: the array of corresponding names
numberOfVar,: number of elements to be set
idx,: the array of indices for the elements that are to be set
value,: the array of the corresponding values
name,: the array of the corresponding names

Definition at line 5298 of file OSOption.cpp.

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

A function to add a element.

Parameters:
idx,: the index of the variable to be given an initial value
value,: the initial string value to be added

Definition at line 5330 of file OSOption.cpp.

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

Alternative signature for this function.

A function to add several elements.

A function to add an array of elements simultaneously

Parameters:
numberOfVar,: number of elements to be set
var,: the array of elements that are to be set
numberOfVar,: number of elements to be added
var,: the array of elements that are to be added

Definition at line 5374 of file OSOption.cpp.


Member Data Documentation

number of children

Definition at line 1271 of file OSOption.h.

initial value for each variable

Definition at line 1274 of file OSOption.h.


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

Generated on 15 Jul 2012 by  doxygen 1.6.1