InitVariableValues Class Reference

the InitVariableValues class. More...

#include <OSOption.h>

Collaboration diagram for InitVariableValues:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

Detailed Description

the InitVariableValues class.

Author:
Robert Fourer, Gus 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 1119 of file OSOption.h.


Constructor & Destructor Documentation

InitVariableValues::InitVariableValues (  ) 

Default constructor.

Definition at line 457 of file OSOption.cpp.

InitVariableValues::~InitVariableValues (  ) 

Class destructor.

Definition at line 466 of file OSOption.cpp.


Member Function Documentation

bool InitVariableValues::IsEqual ( InitVariableValues that  ) 

A function to check for the equality of two objects.

Definition at line 9717 of file OSOption.cpp.

bool InitVariableValues::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" atrbutes and <XXX> children)

Definition at line 11516 of file OSOption.cpp.

bool InitVariableValues::setVar ( int  numberOfVar,
InitVarValue **  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 4906 of file OSOption.cpp.

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

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 4945 of file OSOption.cpp.

bool InitVariableValues::addVar ( int  idx,
double  value 
)

A function to add a element.

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

Definition at line 4977 of file OSOption.cpp.


Member Data Documentation

number of children

Definition at line 1124 of file OSOption.h.

initial value for each variable

Definition at line 1127 of file OSOption.h.


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

Generated on 16 Feb 2012 by  doxygen 1.6.1