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

The GeneralOption Class. More...

#include <OSOption.h>

+ Collaboration diagram for GeneralOption:

Public Member Functions

 GeneralOption ()
 Default constructor. More...
 
 ~GeneralOption ()
 Class destructor. More...
 
bool IsEqual (GeneralOption *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...
 
bool deepCopyFrom (GeneralOption *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

std::string serviceURI
 the service URI More...
 
std::string serviceName
 the name of the service More...
 
std::string instanceName
 the name of the instance More...
 
InstanceLocationOption * instanceLocation
 the location of the instance More...
 
std::string jobID
 the job ID More...
 
std::string solverToInvoke
 the solver to invoke More...
 
std::string license
 the license information More...
 
std::string userName
 the username More...
 
std::string password
 the password More...
 
ContactOption * contact
 the contact method More...
 
OtherOptions * otherOptions
 the list of other general options More...
 

Detailed Description

The GeneralOption Class.

Author
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version
1.0, 21/07/2008
Since
OS 1.1
Remarks
A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 284 of file OSOption.h.

Constructor & Destructor Documentation

GeneralOption::GeneralOption ( )

Default constructor.

GeneralOption::~GeneralOption ( )

Class destructor.

Member Function Documentation

bool GeneralOption::IsEqual ( GeneralOption *  that)

A function to check for the equality of two objects.

bool GeneralOption::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)
bool GeneralOption::deepCopyFrom ( GeneralOption *  that)

A function to make a deep copy of an instance of this class.

Parameters
thatthe instance from which information is to be copied
Returns
whether the copy was created successfully

Member Data Documentation

std::string GeneralOption::serviceURI

the service URI

Definition at line 290 of file OSOption.h.

std::string GeneralOption::serviceName

the name of the service

Definition at line 293 of file OSOption.h.

std::string GeneralOption::instanceName

the name of the instance

Definition at line 296 of file OSOption.h.

InstanceLocationOption* GeneralOption::instanceLocation

the location of the instance

Definition at line 299 of file OSOption.h.

std::string GeneralOption::jobID

the job ID

Definition at line 302 of file OSOption.h.

std::string GeneralOption::solverToInvoke

the solver to invoke

Definition at line 305 of file OSOption.h.

std::string GeneralOption::license

the license information

Definition at line 308 of file OSOption.h.

std::string GeneralOption::userName

the username

Definition at line 311 of file OSOption.h.

std::string GeneralOption::password

the password

Definition at line 314 of file OSOption.h.

ContactOption* GeneralOption::contact

the contact method

Definition at line 317 of file OSOption.h.

OtherOptions* GeneralOption::otherOptions

the list of other general options

Definition at line 320 of file OSOption.h.


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