OS  2.10.2
Public Member Functions | Public Attributes | List of all members
GeneralResult Class Reference

The GeneralResult Class. More...

#include <OSResult.h>

+ Collaboration diagram for GeneralResult:

Public Member Functions

 GeneralResult ()
 Default constructor. More...
 
 ~GeneralResult ()
 Class destructor. More...
 
bool IsEqual (GeneralResult *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class. More...
 

Public Attributes

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

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 266 of file OSResult.h.

Constructor & Destructor Documentation

◆ GeneralResult()

GeneralResult::GeneralResult ( )

Default constructor.

◆ ~GeneralResult()

GeneralResult::~GeneralResult ( )

Class destructor.

Member Function Documentation

◆ IsEqual()

bool GeneralResult::IsEqual ( GeneralResult that)

A function to check for the equality of two objects.

◆ setRandom()

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

Member Data Documentation

◆ generalStatus

GeneralStatus* GeneralResult::generalStatus

a pointer to the GeneralStatus class

Definition at line 272 of file OSResult.h.

◆ message

std::string GeneralResult::message

any general message associated with the optimization

Definition at line 276 of file OSResult.h.

◆ serviceURI

std::string GeneralResult::serviceURI

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

Definition at line 281 of file OSResult.h.

◆ serviceName

std::string GeneralResult::serviceName

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

Definition at line 286 of file OSResult.h.

◆ instanceName

std::string GeneralResult::instanceName

the name of the instance that was solved

Definition at line 290 of file OSResult.h.

◆ jobID

std::string GeneralResult::jobID

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

Definition at line 295 of file OSResult.h.

◆ solverInvoked

std::string GeneralResult::solverInvoked

the name of the solver used

Definition at line 299 of file OSResult.h.

◆ timeStamp

std::string GeneralResult::timeStamp

a time stamp associated with the process

Definition at line 303 of file OSResult.h.

◆ otherResults

OtherResults* GeneralResult::otherResults

a pointer to the OtherResults class

Definition at line 307 of file OSResult.h.


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