My Project
GeneralOption Class Reference

The GeneralOption Class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

std::string serviceURI
 the service URI
 
std::string serviceName
 the name of the service
 
std::string instanceName
 the name of the instance
 
InstanceLocationOptioninstanceLocation
 the location of the instance
 
std::string jobID
 the job ID
 
std::string solverToInvoke
 the solver to invoke
 
std::string license
 the license information
 
std::string userName
 the username
 
std::string password
 the password
 
ContactOptioncontact
 the contact method
 
OtherOptionsotherOptions
 the list of other general options
 

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::GeneralOption ( )

Default constructor.

Definition at line 113 of file OSOption.cpp.

◆ ~GeneralOption()

GeneralOption::~GeneralOption ( )

Class destructor.

Definition at line 131 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool GeneralOption::IsEqual ( GeneralOption * that)

A function to check for the equality of two objects.

Definition at line 9661 of file OSOption.cpp.

◆ setRandom()

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)

Definition at line 12238 of file OSOption.cpp.

◆ deepCopyFrom()

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

Definition at line 13353 of file OSOption.cpp.

Member Data Documentation

◆ serviceURI

std::string GeneralOption::serviceURI

the service URI

Definition at line 290 of file OSOption.h.

◆ serviceName

std::string GeneralOption::serviceName

the name of the service

Definition at line 293 of file OSOption.h.

◆ instanceName

std::string GeneralOption::instanceName

the name of the instance

Definition at line 296 of file OSOption.h.

◆ instanceLocation

InstanceLocationOption* GeneralOption::instanceLocation

the location of the instance

Definition at line 299 of file OSOption.h.

◆ jobID

std::string GeneralOption::jobID

the job ID

Definition at line 302 of file OSOption.h.

◆ solverToInvoke

std::string GeneralOption::solverToInvoke

the solver to invoke

Definition at line 305 of file OSOption.h.

◆ license

std::string GeneralOption::license

the license information

Definition at line 308 of file OSOption.h.

◆ userName

std::string GeneralOption::userName

the username

Definition at line 311 of file OSOption.h.

◆ password

std::string GeneralOption::password

the password

Definition at line 314 of file OSOption.h.

◆ contact

ContactOption* GeneralOption::contact

the contact method

Definition at line 317 of file OSOption.h.

◆ otherOptions

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 files: