InitObjectiveBounds Class Reference

the InitObjectiveBounds class. More...

#include <OSOption.h>

Collaboration diagram for InitObjectiveBounds:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 InitObjectiveBounds ()
 Default constructor.
 ~InitObjectiveBounds ()
 Class destructor.
bool IsEqual (InitObjectiveBounds *that)
 A function to check for the equality of two objects.
bool setObj (int numberOfObj, InitObjBound **obj)
 A function to set an array of <obj> elements.
bool addObj (int idx, double lbValue, double ubValue)
 A function to add a <obj> element.

Public Attributes

int numberOfObj
 number of <obj> children
InitObjBound ** obj
 initial bounds for each objective

Detailed Description

the InitObjectiveBounds 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 1650 of file OSOption.h.


Constructor & Destructor Documentation

InitObjectiveBounds::InitObjectiveBounds (  ) 

Default constructor.

Definition at line 805 of file OSOption.cpp.

References obj.

InitObjectiveBounds::~InitObjectiveBounds (  ) 

Class destructor.

Definition at line 814 of file OSOption.cpp.

References numberOfObj, and obj.


Member Function Documentation

bool InitObjectiveBounds::IsEqual ( InitObjectiveBounds that  ) 

A function to check for the equality of two objects.

Definition at line 8163 of file OSOption.cpp.

References numberOfObj, and obj.

bool InitObjectiveBounds::setObj ( int  numberOfObj,
InitObjBound **  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 4701 of file OSOption.cpp.

References ErrorClass::errormsg, and obj.

Referenced by OSOption::setInitObjBoundsSparse().

bool InitObjectiveBounds::addObj ( int  idx,
double  lbValue,
double  ubValue 
)

A function to add a <obj> element.

Parameters:
idx,: the index of the objective to be given initial bounds
lbValue,: the initial lower bound for the objective
ubValue,: the initial upper bound for the objective

Definition at line 4735 of file OSOption.cpp.

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

Referenced by OSOption::setAnotherInitObjBound().


Member Data Documentation

int InitObjectiveBounds::numberOfObj

number of <obj> children

Definition at line 1654 of file OSOption.h.

Referenced by addObj(), OSOption::getNumberOfInitObjBounds(), IsEqual(), OSOption::setInitObjBoundsSparse(), and ~InitObjectiveBounds().

InitObjBound** InitObjectiveBounds::obj

initial bounds for each objective

Definition at line 1657 of file OSOption.h.

Referenced by addObj(), OSOption::getInitObjBoundsSparse(), InitObjectiveBounds(), IsEqual(), OSOption::setInitObjBoundsDense(), setObj(), and ~InitObjectiveBounds().


The documentation for this class was generated from the following files:
Generated on Fri Jan 7 03:26:27 2011 by  doxygen 1.4.7