ConstraintOption Class Reference

the ConstraintOption class. More...

#include <OSOption.h>

Collaboration diagram for ConstraintOption:

Collaboration graph
[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 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
InitConstraintValuesinitialConstraintValues
 initial values for the constraints
InitDualVariableValuesinitialDualValues
 initial dual values for the constraints
OtherConstraintOption ** other
 other information about the constraints

Detailed Description

the ConstraintOption class.

Author:
Robert Fourer, Gus 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 2186 of file OSOption.h.


Constructor & Destructor Documentation

ConstraintOption::ConstraintOption (  ) 

Default constructor.

Definition at line 1051 of file OSOption.cpp.

References initialConstraintValues, initialDualValues, and other.

ConstraintOption::~ConstraintOption (  ) 

Class destructor.

Definition at line 1062 of file OSOption.cpp.

References initialConstraintValues, initialDualValues, numberOfOtherConstraintOptions, and other.


Member Function Documentation

bool ConstraintOption::IsEqual ( ConstraintOption that  ) 

A function to check for the equality of two objects.

Definition at line 8354 of file OSOption.cpp.

References initialConstraintValues, initialDualValues, numberOfOtherConstraintOptions, and other.

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

References OtherConstraintOption::category, OtherConstraintOption::con, OtherConstraintOption::description, ErrorClass::errormsg, OtherConstraintOption::name, OtherConstraintOption::numberOfCon, numberOfOtherConstraintOptions, other, OtherConstraintOption::solver, OtherConstraintOption::type, and OtherConstraintOption::value.

Referenced by OSOption::setOtherConstraintOptions().

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

References OtherConstraintOption::category, OtherConstraintOption::con, OtherConstraintOption::description, OtherConstraintOption::name, OtherConstraintOption::numberOfCon, numberOfOtherConstraintOptions, other, OtherConstraintOption::solver, OtherConstraintOption::type, and OtherConstraintOption::value.

Referenced by OSOption::setAnOtherConstraintOption().


Member Data Documentation

int ConstraintOption::numberOfOtherConstraintOptions

number of <other> child elements

Definition at line 2190 of file OSOption.h.

Referenced by addOther(), OSOption::getNumberOfOtherConstraintOptions(), IsEqual(), setOther(), OSOption::setOtherConstraintOptions(), and ~ConstraintOption().

InitConstraintValues* ConstraintOption::initialConstraintValues

initial values for the constraints

Definition at line 2193 of file OSOption.h.

Referenced by ConstraintOption(), OSOption::getInitConValuesSparse(), OSOption::getNumberOfInitConValues(), IsEqual(), OSOption::setAnotherInitConValue(), OSOption::setInitConValuesDense(), OSOption::setInitConValuesSparse(), and ~ConstraintOption().

InitDualVariableValues* ConstraintOption::initialDualValues

initial dual values for the constraints

Definition at line 2196 of file OSOption.h.

Referenced by ConstraintOption(), OSOption::getInitDualVarValuesSparse(), OSOption::getNumberOfInitDualVarValues(), IsEqual(), OSOption::setAnotherInitDualVarValue(), OSOption::setInitDualVarValuesDense(), OSOption::setInitDualVarValuesSparse(), and ~ConstraintOption().

OtherConstraintOption** ConstraintOption::other

other information about the constraints

Definition at line 2199 of file OSOption.h.

Referenced by addOther(), ConstraintOption(), OSOption::getAllOtherConstraintOptions(), IsEqual(), setOther(), and ~ConstraintOption().


The documentation for this class was generated from the following files:
Generated on Thu Aug 5 03:10:25 2010 by  doxygen 1.4.7