OS  2.10.1
Public Member Functions | Public Attributes | List of all members
OtherVariableResult Class Reference

The OtherVariableResult Class. More...

#include <OSResult.h>

+ Collaboration diagram for OtherVariableResult:

Public Member Functions

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

int numberOfVar
 the number of variables which have values for this particular type of result More...
 
int numberOfEnumerations
 the number of distinct values for this particular type of result More...
 
std::string name
 the name of the result the user is defining More...
 
std::string value
 this element allows a specific value associated with this particular type of result More...
 
std::string type
 type of the result value (integer, double, boolean, string) More...
 
std::string description
 a brief description of the type of result More...
 
std::string solver
 the solver of the result value More...
 
std::string category
 the category of the result value More...
 
OtherVarResult ** var
 
std::string varType
 type of the values in the var array More...
 
OtherOptionOrResultEnumeration ** enumeration
 
std::string enumType
 type of the values in the enumeration array More...
 

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

Constructor & Destructor Documentation

§ OtherVariableResult()

OtherVariableResult::OtherVariableResult ( )

Default constructor.

§ ~OtherVariableResult()

OtherVariableResult::~OtherVariableResult ( )

Class destructor.

Member Function Documentation

§ IsEqual()

bool OtherVariableResult::IsEqual ( OtherVariableResult that)

A function to check for the equality of two objects.

§ setRandom()

bool OtherVariableResult::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

§ numberOfVar

int OtherVariableResult::numberOfVar

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

Definition at line 1131 of file OSResult.h.

§ numberOfEnumerations

int OtherVariableResult::numberOfEnumerations

the number of distinct values for this particular type of result

Definition at line 1136 of file OSResult.h.

§ name

std::string OtherVariableResult::name

the name of the result the user is defining

Definition at line 1139 of file OSResult.h.

§ value

std::string OtherVariableResult::value

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

Definition at line 1144 of file OSResult.h.

§ type

std::string OtherVariableResult::type

type of the result value (integer, double, boolean, string)

Definition at line 1147 of file OSResult.h.

§ description

std::string OtherVariableResult::description

a brief description of the type of result

Definition at line 1150 of file OSResult.h.

§ solver

std::string OtherVariableResult::solver

the solver of the result value

Definition at line 1153 of file OSResult.h.

§ category

std::string OtherVariableResult::category

the category of the result value

Definition at line 1156 of file OSResult.h.

§ var

OtherVarResult** OtherVariableResult::var

Definition at line 1162 of file OSResult.h.

§ varType

std::string OtherVariableResult::varType

type of the values in the var array

Definition at line 1165 of file OSResult.h.

§ enumeration

OtherOptionOrResultEnumeration** OtherVariableResult::enumeration

Definition at line 1171 of file OSResult.h.

§ enumType

std::string OtherVariableResult::enumType

type of the values in the enumeration array

Definition at line 1174 of file OSResult.h.


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