GeneralResult Class Reference

The GeneralResult Class. More...

#include <OSResult.h>

Collaboration diagram for GeneralResult:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Public Attributes

GeneralStatusgeneralStatus
 a pointer to the GeneralStatus class
std::string message
 any general message associated with the optimization
std::string serviceURI
 the serviceURI is the URI of the solver service that did the optimiation
std::string serviceName
 the serviceName is the name of the sovler service that did the optimization
std::string instanceName
 the name of the instance that was solved
std::string jobID
 the jobID is the ID associated with the solution of this instance
std::string solverInvoked
 the name of the solver used
std::string timeStamp
 a time stamp associated with the process
OtherResultsotherResults
 a pointer to the OtherResults class
GeneralStatusgeneralStatus
 a pointer to the GeneralStatus class
std::string time
 the time when solution was complete kippster -- verify this

Detailed Description

The GeneralResult Class.

Author:
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 03/14/2004
Since:
OS 1.0
Remarks:
A class that provides the general information that is defined in the OSrL schema.

Definition at line 227 of file OSResult.h.


Constructor & Destructor Documentation

GeneralResult::GeneralResult (  ) 

Default constructor.

Definition at line 128 of file OSResult.cpp.

GeneralResult::~GeneralResult (  ) 

Class destructor.

Definition at line 145 of file OSResult.cpp.

References generalStatus, and otherResults.

GeneralResult::GeneralResult (  ) 

Default constructor.

GeneralResult::~GeneralResult (  ) 

Class destructor.


Member Function Documentation

bool GeneralResult::IsEqual ( GeneralResult that  ) 

A function to check for the equality of two objects.

Definition at line 4595 of file OSResult.cpp.

References generalStatus, instanceName, jobID, message, otherResults, serviceName, serviceURI, solverInvoked, and timeStamp.


Member Data Documentation

GeneralStatus* GeneralResult::generalStatus

a pointer to the GeneralStatus class

Definition at line 232 of file OSResult.h.

Referenced by OSResult::getGeneralStatus(), OSResult::getGeneralStatusDescription(), OSResult::getGeneralStatusType(), OSResult::getGeneralSubstatusDescription(), OSResult::getGeneralSubstatusName(), OSResult::getNumberOfGeneralSubstatuses(), IsEqual(), OSResult::setGeneralStatus(), OSResult::setNumberOfGeneralSubstatuses(), OSrLWriter::writeOSrL(), and ~GeneralResult().

std::string GeneralResult::message

any general message associated with the optimization

Definition at line 236 of file OSResult.h.

Referenced by OSResult::getGeneralMessage(), IsEqual(), and OSrLWriter::writeOSrL().

std::string GeneralResult::serviceURI

the serviceURI is the URI of the solver service that did the optimiation

Definition at line 241 of file OSResult.h.

Referenced by OSResult::getServiceURI(), IsEqual(), and OSrLWriter::writeOSrL().

std::string GeneralResult::serviceName

the serviceName is the name of the sovler service that did the optimization

Definition at line 246 of file OSResult.h.

Referenced by OSResult::getServiceName(), IsEqual(), and OSrLWriter::writeOSrL().

std::string GeneralResult::instanceName

the name of the instance that was solved

Definition at line 250 of file OSResult.h.

Referenced by OSResult::getInstanceName(), IsEqual(), and OSrLWriter::writeOSrL().

std::string GeneralResult::jobID

the jobID is the ID associated with the solution of this instance

Definition at line 255 of file OSResult.h.

Referenced by OSResult::getJobID(), IsEqual(), and OSrLWriter::writeOSrL().

std::string GeneralResult::solverInvoked

the name of the solver used

Definition at line 259 of file OSResult.h.

Referenced by OSResult::getSolverInvoked(), IsEqual(), and OSrLWriter::writeOSrL().

std::string GeneralResult::timeStamp

a time stamp associated with the process

Definition at line 263 of file OSResult.h.

Referenced by OSResult::getTimeStamp(), IsEqual(), and OSrLWriter::writeOSrL().

OtherResults* GeneralResult::otherResults

a pointer to the OtherResults class

Definition at line 267 of file OSResult.h.

Referenced by OSResult::getNumberOfOtherGeneralResults(), OSResult::getOtherGeneralResultDescription(), OSResult::getOtherGeneralResultName(), OSResult::getOtherGeneralResultValue(), IsEqual(), OSResult::setNumberOfOtherGeneralResults(), OSrLWriter::writeOSrL(), and ~GeneralResult().

GeneralStatus* GeneralResult::generalStatus

a pointer to the GeneralStatus class

Definition at line 115 of file OSResult.h.

std::string GeneralResult::time

the time when solution was complete kippster -- verify this

Definition at line 138 of file OSResult.h.


The documentation for this class was generated from the following files:
Generated on Sun Mar 20 03:10:56 2011 by  doxygen 1.4.7