OS  2.10.1
Public Member Functions | Public Attributes | List of all members
OtherObjectiveOption Class Reference

the OtherObjectiveOption class. More...

#include <OSOption.h>

+ Collaboration diagram for OtherObjectiveOption:

Public Member Functions

 OtherObjectiveOption ()
 Default constructor. More...
 
 ~OtherObjectiveOption ()
 Class destructor. More...
 
bool IsEqual (OtherObjectiveOption *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 (OtherObjectiveOption *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setObj (int numberOfObj, OtherObjOption **obj)
 A function to set an array of <obj> elements. More...
 
bool addObj (int idx, std::string value, std::string lbValue, std::string ubValue)
 A function to add a <obj> element. More...
 

Public Attributes

int numberOfObj
 number of <obj> children More...
 
int numberOfEnumerations
 number of <enumeration> child elements More...
 
std::string name
 name of the option More...
 
std::string value
 value of the option More...
 
std::string solver
 name of the solver to which this option applies More...
 
std::string category
 name of the category into which this option falls More...
 
std::string type
 type of the option value (integer, double, boolean, string) More...
 
std::string description
 description of the option More...
 
OtherObjOption ** obj
 array of option values More...
 
std::string objType
 type of the values in the obj array More...
 
OtherOptionOrResultEnumeration ** enumeration
 
std::string enumType
 type of the values in the enumeration array More...
 

Detailed Description

the OtherObjectiveOption 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 2574 of file OSOption.h.

Constructor & Destructor Documentation

§ OtherObjectiveOption()

OtherObjectiveOption::OtherObjectiveOption ( )

Default constructor.

§ ~OtherObjectiveOption()

OtherObjectiveOption::~OtherObjectiveOption ( )

Class destructor.

Member Function Documentation

§ IsEqual()

bool OtherObjectiveOption::IsEqual ( OtherObjectiveOption that)

A function to check for the equality of two objects.

§ setRandom()

bool OtherObjectiveOption::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 OtherObjectiveOption::deepCopyFrom ( OtherObjectiveOption 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

§ setObj()

bool OtherObjectiveOption::setObj ( int  numberOfObj,
OtherObjOption **  obj 
)

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

Parameters
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set

§ addObj()

bool OtherObjectiveOption::addObj ( int  idx,
std::string  value,
std::string  lbValue,
std::string  ubValue 
)

A function to add a <obj> element.

Parameters
idxthe index of the objective
valuethe value associated with this objective
lbValuea lower bound associated with this objective
ubValuean upper bound associated with this objective

Member Data Documentation

§ numberOfObj

int OtherObjectiveOption::numberOfObj

number of <obj> children

Definition at line 2579 of file OSOption.h.

§ numberOfEnumerations

int OtherObjectiveOption::numberOfEnumerations

number of <enumeration> child elements

Definition at line 2582 of file OSOption.h.

§ name

std::string OtherObjectiveOption::name

name of the option

Definition at line 2585 of file OSOption.h.

§ value

std::string OtherObjectiveOption::value

value of the option

Definition at line 2588 of file OSOption.h.

§ solver

std::string OtherObjectiveOption::solver

name of the solver to which this option applies

Definition at line 2591 of file OSOption.h.

§ category

std::string OtherObjectiveOption::category

name of the category into which this option falls

Definition at line 2594 of file OSOption.h.

§ type

std::string OtherObjectiveOption::type

type of the option value (integer, double, boolean, string)

Definition at line 2597 of file OSOption.h.

§ description

std::string OtherObjectiveOption::description

description of the option

Definition at line 2600 of file OSOption.h.

§ obj

OtherObjOption** OtherObjectiveOption::obj

array of option values

Definition at line 2603 of file OSOption.h.

§ objType

std::string OtherObjectiveOption::objType

type of the values in the obj array

Definition at line 2606 of file OSOption.h.

§ enumeration

OtherOptionOrResultEnumeration** OtherObjectiveOption::enumeration

Definition at line 2612 of file OSOption.h.

§ enumType

std::string OtherObjectiveOption::enumType

type of the values in the enumeration array

Definition at line 2615 of file OSOption.h.


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