GeneralOption Class Reference

The GeneralOption Class. More...

#include <OSOption.h>

Collaboration diagram for GeneralOption:
Collaboration graph
[legend]

List of all members.

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 285 of file OSOption.h.


Constructor & Destructor Documentation

GeneralOption::GeneralOption (  ) 

Default constructor.

Definition at line 113 of file OSOption.cpp.

GeneralOption::~GeneralOption (  ) 

Class destructor.

Definition at line 131 of file OSOption.cpp.


Member Function Documentation

bool GeneralOption::IsEqual ( GeneralOption that  ) 

A function to check for the equality of two objects.

Definition at line 9658 of file OSOption.cpp.

bool GeneralOption::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" attributes and <XXX> children)

Definition at line 12235 of file OSOption.cpp.

bool GeneralOption::deepCopyFrom ( GeneralOption that  ) 

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

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

Definition at line 13349 of file OSOption.cpp.


Member Data Documentation

the service URI

Definition at line 291 of file OSOption.h.

the name of the service

Definition at line 294 of file OSOption.h.

the name of the instance

Definition at line 297 of file OSOption.h.

the location of the instance

Definition at line 300 of file OSOption.h.

std::string GeneralOption::jobID

the job ID

Definition at line 303 of file OSOption.h.

the solver to invoke

Definition at line 306 of file OSOption.h.

the license information

Definition at line 309 of file OSOption.h.

the username

Definition at line 312 of file OSOption.h.

the password

Definition at line 315 of file OSOption.h.

the contact method

Definition at line 318 of file OSOption.h.

the list of other general options

Definition at line 321 of file OSOption.h.


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

Generated on 24 Jul 2013 by  doxygen 1.6.1