ConstraintOption Class Reference

the ConstraintOption class. More...

#include <OSOption.h>

Collaboration diagram for ConstraintOption:

[legend]

List of all members.

Public Member Functions
	ConstraintOption ()
	Default constructor.
	~ConstraintOption ()
	Class destructor.
bool	IsEqual (ConstraintOption *that)
	A function to check for the equality of two objects.
bool	setRandom (double density, bool conformant)
	A function to make a random instance of this class.
bool	deepCopyFrom (ConstraintOption *that)
	A function to make a deep copy of an instance of this class.
bool	setOther (int numberOfOptions, OtherConstraintOption **other)
	A function to set an array of <other> elements.
bool	addOther (OtherConstraintOption *other)
	A function to add an <other> element.
Public Attributes
int	numberOfOtherConstraintOptions
	number of <other> child elements
InitConstraintValues *	initialConstraintValues
	initial values for the constraints
InitDualVariableValues *	initialDualValues
	initial dual values for the constraints
BasisStatus *	initialBasisStatus
	initial basis status for the slack variables
OtherConstraintOption **	other
	other information about the constraints

---

Detailed Description

the ConstraintOption 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 3263 of file OSOption.h.

---

Constructor & Destructor Documentation

ConstraintOption::ConstraintOption

(

)

Default constructor.

Definition at line 1142 of file OSOption.cpp.

ConstraintOption::~ConstraintOption

(

)

Class destructor.

Definition at line 1154 of file OSOption.cpp.

---

Member Function Documentation

bool ConstraintOption::IsEqual

(

ConstraintOption *

that

)

A function to check for the equality of two objects.

Definition at line 11709 of file OSOption.cpp.

bool ConstraintOption::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 13065 of file OSOption.cpp.

bool ConstraintOption::deepCopyFrom

(

ConstraintOption *

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

bool ConstraintOption::setOther	(	int	numberOfOptions,
		OtherConstraintOption **	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

Definition at line 7271 of file OSOption.cpp.

bool ConstraintOption::addOther

(

OtherConstraintOption *

other

)

A function to add an <other> element.

Parameters:

other,:

the content of the <other> element to be added

Definition at line 7346 of file OSOption.cpp.

---

Member Data Documentation

int ConstraintOption::numberOfOtherConstraintOptions

number of <other> child elements

Definition at line 3268 of file OSOption.h.

InitConstraintValues* ConstraintOption::initialConstraintValues

initial values for the constraints

Definition at line 3271 of file OSOption.h.

InitDualVariableValues* ConstraintOption::initialDualValues

initial dual values for the constraints

Definition at line 3274 of file OSOption.h.

BasisStatus* ConstraintOption::initialBasisStatus

initial basis status for the slack variables

Definition at line 3277 of file OSOption.h.

OtherConstraintOption** ConstraintOption::other

other information about the constraints

Definition at line 3280 of file OSOption.h.

---

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

• /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSOption.h
• /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSOption.cpp