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 setVar (int numberOfVar, InitVarValue **var)
 A function to set an array of elements.
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 890 of file OSOption.h.


Constructor & Destructor Documentation

InitVariableValues::InitVariableValues (  ) 

Default constructor.

Definition at line 446 of file OSOption.cpp.

References var.

InitVariableValues::~InitVariableValues (  ) 

Class destructor.

Definition at line 455 of file OSOption.cpp.

References numberOfVar, and var.


Member Function Documentation

bool InitVariableValues::IsEqual ( InitVariableValues that  ) 

A function to check for the equality of two objects.

Definition at line 7518 of file OSOption.cpp.

References numberOfVar, and var.

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

References ErrorClass::errormsg, and var.

Referenced by OSOption::setInitVarValuesSparse().

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

References ErrorClass::errormsg, InitVarValue::idx, numberOfVar, InitVarValue::value, and var.

Referenced by OSOption::setAnotherInitVarValue().


Member Data Documentation

int InitVariableValues::numberOfVar

number of children

Definition at line 894 of file OSOption.h.

Referenced by addVar(), OSOption::getNumberOfInitVarValues(), IsEqual(), OSOption::setInitVarValuesSparse(), and ~InitVariableValues().

InitVarValue** InitVariableValues::var

initial value for each variable

Definition at line 897 of file OSOption.h.

Referenced by addVar(), OSOption::getInitVarValuesSparse(), InitVariableValues(), IsEqual(), OSOption::setInitVarValuesDense(), setVar(), and ~InitVariableValues().


The documentation for this class was generated from the following files:
Generated on Sun Jan 2 03:06:16 2011 by  doxygen 1.4.7