SolverOption Class Reference

the SolverOption class. More...

#include <OSOption.h>

Collaboration diagram for SolverOption:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SolverOption ()
 Default constructor.
 ~SolverOption ()
 Class destructor.
bool IsEqual (SolverOption *that)
 A function to check for the equality of two objects.

Public Attributes

std::string name
 the name of the option
std::string value
 the value of the option
std::string solver
 the solver to which the option applies
std::string category
 the category to which the option belongs
std::string type
 the type of the option value (integer, double, boolean, string)
std::string description
 the description of the option

Detailed Description

the SolverOption 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 2244 of file OSOption.h.


Constructor & Destructor Documentation

SolverOption::SolverOption (  ) 

Default constructor.

Definition at line 1084 of file OSOption.cpp.

SolverOption::~SolverOption (  ) 

Class destructor.

Definition at line 1097 of file OSOption.cpp.


Member Function Documentation

bool SolverOption::IsEqual ( SolverOption that  ) 

A function to check for the equality of two objects.

Definition at line 8696 of file OSOption.cpp.

References category, description, name, solver, type, and value.


Member Data Documentation

std::string SolverOption::name

the name of the option

Definition at line 2248 of file OSOption.h.

Referenced by SolverOptions::addSolverOption(), and IsEqual().

std::string SolverOption::value

the value of the option

Definition at line 2251 of file OSOption.h.

Referenced by SolverOptions::addSolverOption(), and IsEqual().

std::string SolverOption::solver

the solver to which the option applies

Definition at line 2254 of file OSOption.h.

Referenced by SolverOptions::addSolverOption(), and IsEqual().

std::string SolverOption::category

the category to which the option belongs

Definition at line 2257 of file OSOption.h.

Referenced by SolverOptions::addSolverOption(), and IsEqual().

std::string SolverOption::type

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

Definition at line 2260 of file OSOption.h.

Referenced by SolverOptions::addSolverOption(), and IsEqual().

std::string SolverOption::description

the description of the option

Definition at line 2263 of file OSOption.h.

Referenced by SolverOptions::addSolverOption(), and IsEqual().


The documentation for this class was generated from the following files:
Generated on Fri Jan 7 03:27:20 2011 by  doxygen 1.4.7