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.
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class.
bool deepCopyFrom (SolverOption *that)
 A function to make a deep copy of an instance of this class.

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
int numberOfItems
 the number of items (additional pieces of data) of the option
std::string * item
 the list of items of the option

Detailed Description

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


Constructor & Destructor Documentation

SolverOption::SolverOption (  ) 

Default constructor.

Definition at line 1179 of file OSOption.cpp.

SolverOption::~SolverOption (  ) 

Class destructor.

Definition at line 1194 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 12128 of file OSOption.cpp.

bool SolverOption::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 13266 of file OSOption.cpp.

bool SolverOption::deepCopyFrom ( SolverOption 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 14338 of file OSOption.cpp.


Member Data Documentation

std::string SolverOption::name

the name of the option

Definition at line 3347 of file OSOption.h.

std::string SolverOption::value

the value of the option

Definition at line 3350 of file OSOption.h.

std::string SolverOption::solver

the solver to which the option applies

Definition at line 3353 of file OSOption.h.

the category to which the option belongs

Definition at line 3356 of file OSOption.h.

std::string SolverOption::type

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

Definition at line 3359 of file OSOption.h.

the description of the option

Definition at line 3362 of file OSOption.h.

the number of items (additional pieces of data) of the option

Definition at line 3365 of file OSOption.h.

std::string* SolverOption::item

the list of items of the option

Definition at line 3368 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