#include <OSOption.h>

Collaboration diagram for InitVariableValues:

Public Member Functions
	InitVariableValues ()
	Default constructor. More...

	~InitVariableValues ()
	Class destructor. More...

bool	IsEqual (InitVariableValues *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 (InitVariableValues *that)
	A function to make a deep copy of an instance of this class. More...

bool	setVar (int numberOfVar, InitVarValue **var)
	A function to set an array of elements. More...

bool	setVar (int numberOfVar, InitVarValue **var, ENUM_COMBINE_ARRAYS disp)
	Alternative signature for this function. More...

bool	setVar (int numberOfVar, int idx, double value, std::string *name)
	Another alternative signature for this function. More...

bool	addVar (int idx, double value)
	A function to add a element. More...

bool	addVar (int numberOfVar, InitVarValue **var)
	Alternative signature for this function. More...

Public Attributes
int	numberOfVar
	number of children More...

InitVarValue **	var
	initial value for each variable More...

Detailed Description

the InitVariableValues 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 1218 of file OSOption.h.

Constructor & Destructor Documentation

InitVariableValues::InitVariableValues ( )

Default constructor.

Definition at line 454 of file OSOption.cpp.

InitVariableValues::~InitVariableValues ( )

Class destructor.

Definition at line 463 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 10702 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" attributes and <XXX> children)

Definition at line 12658 of file OSOption.cpp.

bool InitVariableValues::deepCopyFrom ( InitVariableValues * that )

A function to make a deep copy of an instance of this class.

Parameters

that,: the instance from which information is to be copied

Returns: whether the copy was created successfully

Definition at line 13782 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 5013 of file OSOption.cpp.

bool InitVariableValues::setVar	(	int	numberOfVar,
		InitVarValue **	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

Definition at line 5051 of file OSOption.cpp.

bool InitVariableValues::setVar	(	int	numberOfVar,
		int *	idx,
		double *	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 5105 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 5136 of file OSOption.cpp.

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

Member Data Documentation

int InitVariableValues::numberOfVar

number of children

Definition at line 1223 of file OSOption.h.

InitVarValue** InitVariableValues::var

initial value for each variable

Definition at line 1226 of file OSOption.h.

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

/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation