ObjectiveOption Class Reference

the ObjectiveOption class. More...

#include <OSOption.h>

Collaboration diagram for ObjectiveOption:

Public Member Functions
	ObjectiveOption ()
	Default constructor. More...
	~ObjectiveOption ()
	Class destructor. More...
bool	IsEqual (ObjectiveOption *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 (ObjectiveOption *that)
	A function to make a deep copy of an instance of this class. More...
bool	setOther (int numberOfOptions, OtherObjectiveOption **other)
	A function to set an array of <other> elements. More...
bool	addOther (OtherObjectiveOption *other)
	A function to add an <other> element. More...

Public Attributes
int	numberOfOtherObjectiveOptions
	number of <other> child elements More...
InitObjectiveValues *	initialObjectiveValues
	initial values for the objectives More...
InitObjectiveBounds *	initialObjectiveBounds
	initial bounds for the objectives More...
BasisStatus *	initialBasisStatus
	initial basis status for the objectives More...
OtherObjectiveOption **	other
	other information about the objectives More...

Detailed Description

the ObjectiveOption 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 2681 of file OSOption.h.

Constructor & Destructor Documentation

ObjectiveOption::ObjectiveOption

(

)

Default constructor.

ObjectiveOption::~ObjectiveOption

(

)

Class destructor.

Member Function Documentation

bool ObjectiveOption::IsEqual

(

ObjectiveOption *

that

)

A function to check for the equality of two objects.

bool ObjectiveOption::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)

bool ObjectiveOption::deepCopyFrom

(

ObjectiveOption *

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

bool ObjectiveOption::setOther	(	int	numberOfOptions,
		OtherObjectiveOption **	other
	)

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

Parameters

numberOfOptions	number of <other> elements to be set
other	the array of <other> elements that are to be set

bool ObjectiveOption::addOther

(

OtherObjectiveOption *

other

)

A function to add an <other> element.

Parameters

other

the content of the <other> element to be added

Member Data Documentation

int ObjectiveOption::numberOfOtherObjectiveOptions

number of <other> child elements

Definition at line 2686 of file OSOption.h.

InitObjectiveValues* ObjectiveOption::initialObjectiveValues

initial values for the objectives

Definition at line 2689 of file OSOption.h.

InitObjectiveBounds* ObjectiveOption::initialObjectiveBounds

initial bounds for the objectives

Definition at line 2692 of file OSOption.h.

BasisStatus* ObjectiveOption::initialBasisStatus

initial basis status for the objectives

Definition at line 2695 of file OSOption.h.

OtherObjectiveOption** ObjectiveOption::other

other information about the objectives

Definition at line 2698 of file OSOption.h.

---

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

• /builddir/build/BUILD/OS-2.10.1/src/OSCommonInterfaces/OSOption.h