OtherVariableResult Class Reference

The OtherVariableResult Class. More...

#include <OSResult.h>

Collaboration diagram for OtherVariableResult:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OtherVariableResult ()
 Default constructor.
 ~OtherVariableResult ()
 Class destructor.
bool IsEqual (OtherVariableResult *that)
 A function to check for the equality of two objects.
 OtherVariableResult ()
 Default constructor.
 ~OtherVariableResult ()
 Class destructor.

Public Attributes

int numberOfVar
 the number of variables which have values for this particular type of result
int numberOfEnumerations
 the number of distinct values for this particular type of result
std::string name
 the name of the result the user is defining
std::string value
 this element allows a specific value associated with this particular type of result
std::string description
 a brief description of the type of result
OtherVarResult ** var
OtherOptionEnumeration ** enumeration
std::vector< OtherVarResult * > var

Detailed Description

The OtherVariableResult Class.

Author:
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 03/14/2004
Since:
OS 1.0
Remarks:
A class that allows the solver to report an arbitrary result associated with variables

Definition at line 1060 of file OSResult.h.


Constructor & Destructor Documentation

OtherVariableResult::OtherVariableResult (  ) 

Default constructor.

Definition at line 546 of file OSResult.cpp.

OtherVariableResult::~OtherVariableResult (  ) 

Class destructor.

Definition at line 562 of file OSResult.cpp.

References enumeration, numberOfEnumerations, numberOfVar, and var.

OtherVariableResult::OtherVariableResult (  ) 

Default constructor.

OtherVariableResult::~OtherVariableResult (  ) 

Class destructor.


Member Function Documentation

bool OtherVariableResult::IsEqual ( OtherVariableResult that  ) 

A function to check for the equality of two objects.

Definition at line 5686 of file OSResult.cpp.

References description, enumeration, name, numberOfEnumerations, numberOfVar, value, and var.


Member Data Documentation

int OtherVariableResult::numberOfVar

the number of variables which have values for this particular type of result

Definition at line 1066 of file OSResult.h.

Referenced by OSResult::getAnOtherVariableResultNumberOfVar(), OSResult::getOtherVariableResultNumberOfVar(), OSResult::getOtherVariableResultVar(), OSResult::getOtherVariableResultVarIdx(), IsEqual(), main(), OSResult::setOtherVariableResultNumberOfVar(), OSrL2Gams::writeSolution(), and ~OtherVariableResult().

int OtherVariableResult::numberOfEnumerations

the number of distinct values for this particular type of result

Definition at line 1071 of file OSResult.h.

Referenced by IsEqual(), OSResult::setOtherOptionEnumeration(), OSResult::setOtherVariableResultNumberOfEnumerations(), and ~OtherVariableResult().

std::string OtherVariableResult::name

the name of the result the user is defining

Definition at line 1074 of file OSResult.h.

Referenced by OSResult::getOtherVariableResultName(), IsEqual(), main(), OSResult::setOtherVariableResultName(), and OSrL2Gams::writeSolution().

std::string OtherVariableResult::value

this element allows a specific value associated with this particular type of result

Definition at line 1079 of file OSResult.h.

Referenced by OSResult::getOtherVariableResultValue(), IsEqual(), and OSResult::setOtherVariableResultValue().

std::string OtherVariableResult::description

a brief description of the type of result

Definition at line 1082 of file OSResult.h.

Referenced by OSResult::getOtherVariableResultDescription(), IsEqual(), main(), and OSResult::setOtherVariableResultDescription().

OtherVarResult** OtherVariableResult::var

Definition at line 1088 of file OSResult.h.

Referenced by OSResult::getOtherVariableResultVar(), OSResult::getOtherVariableResultVarIdx(), IsEqual(), main(), OSResult::setOtherVariableResultNumberOfVar(), OSResult::setOtherVariableResultVar(), OSResult::setOtherVariableResultVarIdx(), OSrL2Gams::writeSolution(), and ~OtherVariableResult().

OtherOptionEnumeration** OtherVariableResult::enumeration

Definition at line 1094 of file OSResult.h.

Referenced by IsEqual(), OSResult::setOtherOptionEnumeration(), OSResult::setOtherVariableResultNumberOfEnumerations(), and ~OtherVariableResult().

std::vector<OtherVarResult*> OtherVariableResult::var

Definition at line 631 of file OSResult.h.


The documentation for this class was generated from the following files:
Generated on Wed Mar 23 03:09:15 2011 by  doxygen 1.4.7