SolverOutput Class Reference

The SolverOutput Class. More...

#include <OSResult.h>

Collaboration diagram for SolverOutput:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SolverOutput ()
 Default constructor.
 ~SolverOutput ()
 Class destructor.
bool IsEqual (SolverOutput *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.

Public Attributes

std::string name
 the name of the result the user is defining
std::string category
 this element allows a specific category to be associated with this particular type of result
std::string description
 a brief description of the type of result
int numberOfItems
 the number of items contained in this otherSolutionResult
std::string * item
 an array of items (string-valued)

Detailed Description

The SolverOutput Class.

Author:
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 the solution.

Definition at line 2086 of file OSResult.h.


Constructor & Destructor Documentation

SolverOutput::SolverOutput (  ) 

Default constructor.

Definition at line 1039 of file OSResult.cpp.

SolverOutput::~SolverOutput (  ) 

Class destructor.

Definition at line 1052 of file OSResult.cpp.

References item.


Member Function Documentation

bool SolverOutput::IsEqual ( SolverOutput that  ) 

A function to check for the equality of two objects.

Definition at line 7852 of file OSResult.cpp.

References category, DEBUG_ISEQUAL_ROUTINES, description, item, name, and numberOfItems.

bool SolverOutput::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" atrbutes and <XXX> children)

Definition at line 8997 of file OSResult.cpp.

References category, item, n, numberOfItems, and OSRand().

Referenced by OtherSolverOutput::setRandom().


Member Data Documentation

std::string SolverOutput::name

the name of the result the user is defining

Definition at line 2091 of file OSResult.h.

Referenced by OSResult::getSolverOutputName(), IsEqual(), and OSResult::setSolverOutputName().

std::string SolverOutput::category

this element allows a specific category to be associated with this particular type of result

Definition at line 2096 of file OSResult.h.

Referenced by OSResult::getSolverOutputCategory(), IsEqual(), setRandom(), and OSResult::setSolverOutputCategory().

std::string SolverOutput::description

a brief description of the type of result

Definition at line 2099 of file OSResult.h.

Referenced by OSResult::getSolverOutputDescription(), IsEqual(), and OSResult::setSolverOutputDescription().

int SolverOutput::numberOfItems

the number of items contained in this otherSolutionResult

Definition at line 2103 of file OSResult.h.

Referenced by OSResult::getSolverOutputItem(), OSResult::getSolverOutputNumberOfItems(), IsEqual(), setRandom(), and OSResult::setSolverOutputNumberOfItems().

std::string* SolverOutput::item

an array of items (string-valued)

Definition at line 2107 of file OSResult.h.

Referenced by OSResult::getSolverOutputItem(), IsEqual(), setRandom(), OSResult::setSolverOutputItem(), OSResult::setSolverOutputNumberOfItems(), and ~SolverOutput().


The documentation for this class was generated from the following files:
Generated on Wed Nov 30 03:12:17 2011 by  doxygen 1.4.7