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.

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, Gus 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 205 of file OSOption.h.


Constructor & Destructor Documentation

GeneralOption::GeneralOption (  ) 

Default constructor.

Definition at line 114 of file OSOption.cpp.

References contact, instanceLocation, and otherOptions.

GeneralOption::~GeneralOption (  ) 

Class destructor.

Definition at line 132 of file OSOption.cpp.

References contact, instanceLocation, and otherOptions.


Member Function Documentation

bool GeneralOption::IsEqual ( GeneralOption that  ) 

A function to check for the equality of two objects.

Definition at line 6688 of file OSOption.cpp.

References contact, instanceLocation, instanceName, jobID, license, otherOptions, password, serviceName, serviceURI, solverToInvoke, and userName.


Member Data Documentation

std::string GeneralOption::serviceURI

the service URI

Definition at line 210 of file OSOption.h.

Referenced by OSOption::getServiceURI(), IsEqual(), OSOption::setServiceURI(), and OSoLWriter::writeOSoL().

std::string GeneralOption::serviceName

the name of the service

Definition at line 213 of file OSOption.h.

Referenced by OSOption::getServiceName(), IsEqual(), OSOption::setServiceName(), and OSoLWriter::writeOSoL().

std::string GeneralOption::instanceName

the name of the instance

Definition at line 216 of file OSOption.h.

Referenced by OSOption::getInstanceName(), IsEqual(), OSOption::setInstanceName(), and OSoLWriter::writeOSoL().

InstanceLocationOption* GeneralOption::instanceLocation

the location of the instance

Definition at line 219 of file OSOption.h.

Referenced by GeneralOption(), OSOption::getInstanceLocation(), OSOption::getInstanceLocationType(), IsEqual(), OSOption::setInstanceLocation(), OSOption::setInstanceLocationType(), OSoLWriter::writeOSoL(), and ~GeneralOption().

std::string GeneralOption::jobID

the job ID

Definition at line 222 of file OSOption.h.

Referenced by OSOption::getJobID(), IsEqual(), OSOption::setJobID(), and OSoLWriter::writeOSoL().

std::string GeneralOption::solverToInvoke

the solver to invoke

Definition at line 225 of file OSOption.h.

Referenced by OSOption::getSolverToInvoke(), IsEqual(), OSOption::setSolverToInvoke(), and OSoLWriter::writeOSoL().

std::string GeneralOption::license

the license information

Definition at line 228 of file OSOption.h.

Referenced by OSOption::getLicense(), IsEqual(), OSOption::setLicense(), and OSoLWriter::writeOSoL().

std::string GeneralOption::userName

the username

Definition at line 231 of file OSOption.h.

Referenced by OSOption::getUserName(), IsEqual(), OSOption::setUserName(), and OSoLWriter::writeOSoL().

std::string GeneralOption::password

the password

Definition at line 234 of file OSOption.h.

Referenced by OSOption::getPassword(), IsEqual(), OSOption::setPassword(), and OSoLWriter::writeOSoL().

ContactOption* GeneralOption::contact

the contact method

Definition at line 237 of file OSOption.h.

Referenced by GeneralOption(), OSOption::getContact(), OSOption::getContactTransportType(), IsEqual(), OSOption::setContact(), OSOption::setContactTransportType(), OSoLWriter::writeOSoL(), and ~GeneralOption().

OtherOptions* GeneralOption::otherOptions

the list of other general options

Definition at line 240 of file OSOption.h.

Referenced by GeneralOption(), OSOption::getNumberOfOtherGeneralOptions(), OSOption::getOtherGeneralOptions(), IsEqual(), OSOption::setAnOtherGeneralOption(), OSOption::setOtherGeneralOptions(), OSoLWriter::writeOSoL(), and ~GeneralOption().


The documentation for this class was generated from the following files:
Generated on Thu Oct 8 03:08:04 2009 by  doxygen 1.4.7