#include <OSOption.h>

Collaboration diagram for InitObjectiveBounds:

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

	~InitObjectiveBounds ()
	Class destructor. More...

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

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

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

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

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

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

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

InitObjBound **	obj
	initial bounds for each objective More...

Detailed Description

the InitObjectiveBounds 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 2405 of file OSOption.h.

Constructor & Destructor Documentation

InitObjectiveBounds::InitObjectiveBounds ( )

Default constructor.

Definition at line 850 of file OSOption.cpp.

InitObjectiveBounds::~InitObjectiveBounds ( )

Class destructor.

Definition at line 859 of file OSOption.cpp.

Member Function Documentation

bool InitObjectiveBounds::IsEqual ( InitObjectiveBounds * that )

A function to check for the equality of two objects.

Definition at line 11491 of file OSOption.cpp.

bool InitObjectiveBounds::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 12959 of file OSOption.cpp.

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

bool InitObjectiveBounds::setObj	(	int	numberOfObj,
		InitObjBound **	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 6338 of file OSOption.cpp.

bool InitObjectiveBounds::setObj	(	int	numberOfObj,
		InitObjBound **	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 6376 of file OSOption.cpp.

bool InitObjectiveBounds::setObj	(	int	numberOfObj,
		int *	idx,
		double *	lbValue,
		double *	ubValue,
		std::string *	name
	)

Another alternative signature for this function.

Parameters

numberOfObj,:	number of <obj> elements to be set
idx,:	the array of indices
lbValue,:	the array of corresponding lower bounds
ubValue,:	the array of corresponding upper bounds
name,:	the array of objective names

Definition at line 6420 of file OSOption.cpp.

bool InitObjectiveBounds::addObj	(	int	idx,
		double	lbValue,
		double	ubValue
	)

A function to add a <obj> element.

Parameters

idx,:	the index of the objective to be given initial bounds
lbValue,:	the initial lower bound for the objective
ubValue,:	the initial upper bound for the objective

Definition at line 6454 of file OSOption.cpp.

bool InitObjectiveBounds::addObj	(	int	numberOfObj,
		InitObjBound **	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 6498 of file OSOption.cpp.

Member Data Documentation

int InitObjectiveBounds::numberOfObj

number of <obj> children

Definition at line 2410 of file OSOption.h.

InitObjBound** InitObjectiveBounds::obj

initial bounds for each objective

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