My Project
SolverOption Class Reference

the SolverOption class. More...

#include <OSOption.h>

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

Constructor & Destructor Documentation

◆ SolverOption()

SolverOption::SolverOption ( )

Default constructor.

Definition at line 1179 of file OSOption.cpp.

◆ ~SolverOption()

SolverOption::~SolverOption ( )

Class destructor.

Definition at line 1194 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool SolverOption::IsEqual ( SolverOption * that)

A function to check for the equality of two objects.

Definition at line 12131 of file OSOption.cpp.

◆ setRandom()

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

◆ deepCopyFrom()

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

Member Data Documentation

◆ name

std::string SolverOption::name

the name of the option

Definition at line 3349 of file OSOption.h.

◆ value

std::string SolverOption::value

the value of the option

Definition at line 3352 of file OSOption.h.

◆ solver

std::string SolverOption::solver

the solver to which the option applies

Definition at line 3355 of file OSOption.h.

◆ category

std::string SolverOption::category

the category to which the option belongs

Definition at line 3358 of file OSOption.h.

◆ type

std::string SolverOption::type

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

Definition at line 3361 of file OSOption.h.

◆ description

std::string SolverOption::description

the description of the option

Definition at line 3364 of file OSOption.h.

◆ numberOfItems

int SolverOption::numberOfItems

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

Definition at line 3367 of file OSOption.h.

◆ item

std::string* SolverOption::item

the list of items of the option

Definition at line 3370 of file OSOption.h.


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