#include <OSOption.h>

Collaboration diagram for InitObjectiveValues:

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

	~InitObjectiveValues ()
	Class destructor. More...

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

bool	setObj (int numberOfObj, InitObjValue **obj)
	A function to set an array of <obj> elements. More...

bool	setObj (int numberOfObj, InitObjValue **obj, ENUM_COMBINE_ARRAYS disp)
	Alternative signature for this function. More...

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

bool	addObj (int idx, double value)
	A function to add a <obj> element. More...

bool	addObj (int numberOfObj, InitObjValue **obj)
	Alternative signature for this function. More...

Public Attributes
int	numberOfObj
	number of <obj> children More...

InitObjValue **	obj
	initial value for each objective More...

Detailed Description

the InitObjectiveValues 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 2241 of file OSOption.h.

Constructor & Destructor Documentation

InitObjectiveValues::InitObjectiveValues ( )

Default constructor.

Definition at line 803 of file OSOption.cpp.

InitObjectiveValues::~InitObjectiveValues ( )

Class destructor.

Definition at line 812 of file OSOption.cpp.

Member Function Documentation

bool InitObjectiveValues::IsEqual ( InitObjectiveValues * that )

A function to check for the equality of two objects.

Definition at line 11396 of file OSOption.cpp.

bool InitObjectiveValues::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 12920 of file OSOption.cpp.

bool InitObjectiveValues::deepCopyFrom ( InitObjectiveValues * 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 14027 of file OSOption.cpp.

bool InitObjectiveValues::setObj	(	int	numberOfObj,
		InitObjValue **	obj
	)

A function to set an array of <obj> elements.

Parameters

numberOfObj,:	number of <obj> elements to be set
obj,:	the array of <obj> elements that are to be set

Definition at line 6141 of file OSOption.cpp.

bool InitObjectiveValues::setObj	(	int	numberOfObj,
		InitObjValue **	obj,
		ENUM_COMBINE_ARRAYS	disp
	)

Alternative signature for this function.

A function to set an array of <obj> 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
numberOfObj,:	number of <obj> elements to be set
obj,:	the array of <obj> elements that are to be set
disp,:	method of disposition if previous data exist

Definition at line 6179 of file OSOption.cpp.

bool InitObjectiveValues::setObj	(	int	numberOfObj,
		int *	idx,
		double *	value,
		std::string *	name
	)

Another alternative signature for this function.

@param numberOfObj: number of <obj> elements to be set

Parameters

idx,:	the array of indices
value,:	the array of corresponding values
name,:	the array of objective names

Definition at line 6223 of file OSOption.cpp.

bool InitObjectiveValues::addObj	(	int	idx,
		double	value
	)

A function to add a <obj> element.

Parameters

idx,:	the index of the objective to be given an initial value
value,:	the initial value to be added
idx,:	the index of the objective to be given an initial value
value,:	the inital value to be added

Definition at line 6252 of file OSOption.cpp.

bool InitObjectiveValues::addObj	(	int	numberOfObj,
		InitObjValue **	obj
	)

Alternative signature for this function.

A function to add several <obj> elements.

A function to add an array of <obj> elements simultaneously

Parameters

numberOfObj,:	number of <obj> elements to be set
obj,:	the array of <obj> elements that are to be set
numberOfVar,:	number of <obj> elements to be added
obj,:	the array of <obj> elements that are to be added

Definition at line 6295 of file OSOption.cpp.

Member Data Documentation

int InitObjectiveValues::numberOfObj

number of <obj> children

Definition at line 2246 of file OSOption.h.

InitObjValue** InitObjectiveValues::obj

initial value for each objective

Definition at line 2249 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