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

Detailed Description

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


Constructor & Destructor Documentation

OtherObjectiveOption::OtherObjectiveOption (  ) 

Default constructor.

Definition at line 849 of file OSOption.cpp.

References obj.

OtherObjectiveOption::~OtherObjectiveOption (  ) 

Class destructor.

Definition at line 864 of file OSOption.cpp.

References numberOfObj, and obj.


Member Function Documentation

bool OtherObjectiveOption::IsEqual ( OtherObjectiveOption that  ) 

A function to check for the equality of two objects.

Definition at line 8294 of file OSOption.cpp.

References category, description, name, numberOfObj, obj, solver, type, and value.

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

References ErrorClass::errormsg, and obj.

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

References ErrorClass::errormsg, OtherObjOption::idx, OtherObjOption::lbValue, numberOfObj, obj, OtherObjOption::ubValue, and OtherObjOption::value.


Member Data Documentation

int OtherObjectiveOption::numberOfObj

number of <obj> children

Definition at line 1718 of file OSOption.h.

Referenced by addObj(), ObjectiveOption::addOther(), IsEqual(), ObjectiveOption::setOther(), and ~OtherObjectiveOption().

std::string OtherObjectiveOption::name

name of the option

Definition at line 1721 of file OSOption.h.

Referenced by ObjectiveOption::addOther(), IsEqual(), and ObjectiveOption::setOther().

std::string OtherObjectiveOption::value

value of the option

Definition at line 1724 of file OSOption.h.

Referenced by ObjectiveOption::addOther(), IsEqual(), and ObjectiveOption::setOther().

std::string OtherObjectiveOption::solver

name of the solver to which this option applies

Definition at line 1727 of file OSOption.h.

Referenced by ObjectiveOption::addOther(), IsEqual(), and ObjectiveOption::setOther().

std::string OtherObjectiveOption::category

name of the category into which this option falls

Definition at line 1730 of file OSOption.h.

Referenced by ObjectiveOption::addOther(), IsEqual(), and ObjectiveOption::setOther().

std::string OtherObjectiveOption::type

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

Definition at line 1733 of file OSOption.h.

Referenced by ObjectiveOption::addOther(), IsEqual(), and ObjectiveOption::setOther().

std::string OtherObjectiveOption::description

description of the option

Definition at line 1736 of file OSOption.h.

Referenced by ObjectiveOption::addOther(), IsEqual(), and ObjectiveOption::setOther().

OtherObjOption** OtherObjectiveOption::obj

array of option values

Definition at line 1739 of file OSOption.h.

Referenced by addObj(), ObjectiveOption::addOther(), IsEqual(), OtherObjectiveOption(), setObj(), ObjectiveOption::setOther(), and ~OtherObjectiveOption().


The documentation for this class was generated from the following files:
Generated on Thu Oct 8 03:08:27 2009 by  doxygen 1.4.7