OS  2.10.2
Public Member Functions | Public Attributes | List of all members
ConstraintOption Class Reference

the ConstraintOption class. More...

#include <OSOption.h>

+ Collaboration diagram for ConstraintOption:

Public Member Functions

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

Public Attributes

int numberOfOtherConstraintOptions
 number of <other> child elements More...
 
InitConstraintValuesinitialConstraintValues
 initial values for the constraints More...
 
InitDualVariableValuesinitialDualValues
 initial dual values for the constraints More...
 
BasisStatusinitialBasisStatus
 initial basis status for the slack variables More...
 
OtherConstraintOption ** other
 other information about the constraints More...
 

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::ConstraintOption ( )

Default constructor.

◆ ~ConstraintOption()

ConstraintOption::~ConstraintOption ( )

Class destructor.

Member Function Documentation

◆ IsEqual()

bool ConstraintOption::IsEqual ( ConstraintOption that)

A function to check for the equality of two objects.

◆ setRandom()

bool ConstraintOption::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

◆ deepCopyFrom()

bool ConstraintOption::deepCopyFrom ( ConstraintOption that)

A function to make a deep copy of an instance of this class.

Parameters
thatthe instance from which information is to be copied
Returns
whether the copy was created successfully

◆ setOther()

bool ConstraintOption::setOther ( int  numberOfOptions,
OtherConstraintOption **  other 
)

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

Parameters
numberOfOptionsnumber of <other> elements to be set
otherthe array of <other> elements that are to be set

◆ addOther()

bool ConstraintOption::addOther ( OtherConstraintOption other)

A function to add an <other> element.

Parameters
otherthe content of the <other> element to be added

Member Data Documentation

◆ numberOfOtherConstraintOptions

int ConstraintOption::numberOfOtherConstraintOptions

number of <other> child elements

Definition at line 3268 of file OSOption.h.

◆ initialConstraintValues

InitConstraintValues* ConstraintOption::initialConstraintValues

initial values for the constraints

Definition at line 3271 of file OSOption.h.

◆ initialDualValues

InitDualVariableValues* ConstraintOption::initialDualValues

initial dual values for the constraints

Definition at line 3274 of file OSOption.h.

◆ initialBasisStatus

BasisStatus* ConstraintOption::initialBasisStatus

initial basis status for the slack variables

Definition at line 3277 of file OSOption.h.

◆ other

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 file: