OtherObjectiveOption Class Reference

the OtherObjectiveOption class. More...

#include <OSOption.h>

Collaboration diagram for OtherObjectiveOption:
Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

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 2575 of file OSOption.h.


Constructor & Destructor Documentation

OtherObjectiveOption::OtherObjectiveOption (  ) 

Default constructor.

Definition at line 898 of file OSOption.cpp.

OtherObjectiveOption::~OtherObjectiveOption (  ) 

Class destructor.

Definition at line 917 of file OSOption.cpp.


Member Function Documentation

bool OtherObjectiveOption::IsEqual ( OtherObjectiveOption that  ) 

A function to check for the equality of two objects.

Definition at line 11587 of file OSOption.cpp.

bool OtherObjectiveOption::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 12997 of file OSOption.cpp.

bool OtherObjectiveOption::deepCopyFrom ( OtherObjectiveOption 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 14088 of file OSOption.cpp.

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

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

Parameters:
numberOfObj,: number of <obj> elements to be set
obj,: the array of <obj> elements that are to be set

Definition at line 6544 of file OSOption.cpp.

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

A function to add a <obj> element.

Parameters:
idx,: the index of the objective
value,: the value associated with this objective
lbValue,: a lower bound associated with this objective
ubValue,: an upper bound associated with this objective

Definition at line 6583 of file OSOption.cpp.


Member Data Documentation

number of <obj> children

Definition at line 2580 of file OSOption.h.

number of <enumeration> child elements

Definition at line 2583 of file OSOption.h.

name of the option

Definition at line 2586 of file OSOption.h.

value of the option

Definition at line 2589 of file OSOption.h.

name of the solver to which this option applies

Definition at line 2592 of file OSOption.h.

name of the category into which this option falls

Definition at line 2595 of file OSOption.h.

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

Definition at line 2598 of file OSOption.h.

description of the option

Definition at line 2601 of file OSOption.h.

array of option values

Definition at line 2604 of file OSOption.h.

type of the values in the obj array

Definition at line 2607 of file OSOption.h.

Definition at line 2613 of file OSOption.h.

type of the values in the enumeration array

Definition at line 2616 of file OSOption.h.


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

Generated on 24 Jul 2013 by  doxygen 1.6.1