My Project
ObjectiveOption Class Reference

the ObjectiveOption class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

int numberOfOtherObjectiveOptions
 number of <other> child elements
 
InitObjectiveValuesinitialObjectiveValues
 initial values for the objectives
 
InitObjectiveBoundsinitialObjectiveBounds
 initial bounds for the objectives
 
BasisStatusinitialBasisStatus
 initial basis status for the objectives
 
OtherObjectiveOption ** other
 other information about the objectives
 

Detailed Description

the ObjectiveOption 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 2681 of file OSOption.h.

Constructor & Destructor Documentation

◆ ObjectiveOption()

ObjectiveOption::ObjectiveOption ( )

Default constructor.

Definition at line 945 of file OSOption.cpp.

◆ ~ObjectiveOption()

ObjectiveOption::~ObjectiveOption ( )

Class destructor.

Definition at line 957 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool ObjectiveOption::IsEqual ( ObjectiveOption * that)

A function to check for the equality of two objects.

Definition at line 11339 of file OSOption.cpp.

◆ setRandom()

bool ObjectiveOption::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)

Definition at line 12879 of file OSOption.cpp.

◆ deepCopyFrom()

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

Definition at line 13987 of file OSOption.cpp.

◆ setOther()

bool ObjectiveOption::setOther ( int numberOfOptions,
OtherObjectiveOption ** 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

Definition at line 6629 of file OSOption.cpp.

◆ addOther()

bool ObjectiveOption::addOther ( OtherObjectiveOption * other)

A function to add an <other> element.

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

Definition at line 6699 of file OSOption.cpp.

Member Data Documentation

◆ numberOfOtherObjectiveOptions

int ObjectiveOption::numberOfOtherObjectiveOptions

number of <other> child elements

Definition at line 2686 of file OSOption.h.

◆ initialObjectiveValues

InitObjectiveValues* ObjectiveOption::initialObjectiveValues

initial values for the objectives

Definition at line 2689 of file OSOption.h.

◆ initialObjectiveBounds

InitObjectiveBounds* ObjectiveOption::initialObjectiveBounds

initial bounds for the objectives

Definition at line 2692 of file OSOption.h.

◆ initialBasisStatus

BasisStatus* ObjectiveOption::initialBasisStatus

initial basis status for the objectives

Definition at line 2695 of file OSOption.h.

◆ other

OtherObjectiveOption** ObjectiveOption::other

other information about the objectives

Definition at line 2698 of file OSOption.h.


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