the SolverOption class. More...
#include <OSOption.h>
Public Member Functions | |
| SolverOption () | |
| Default constructor. More... | |
| ~SolverOption () | |
| Class destructor. More... | |
| bool | IsEqual (SolverOption *that) |
| A function to check for the equality of two objects. More... | |
| bool | setRandom (double density, bool conformant) |
| A function to make a random instance of this class. More... | |
| bool | deepCopyFrom (SolverOption *that) |
| A function to make a deep copy of an instance of this class. More... | |
Public Attributes | |
| std::string | name |
| the name of the option More... | |
| std::string | value |
| the value of the option More... | |
| std::string | solver |
| the solver to which the option applies More... | |
| std::string | category |
| the category to which the option belongs More... | |
| std::string | type |
| the type of the option value (integer, double, boolean, string) More... | |
| std::string | description |
| the description of the option More... | |
| int | numberOfItems |
| the number of items (additional pieces of data) of the option More... | |
| std::string * | item |
| the list of items of the option More... | |
Detailed Description
the SolverOption class.
- 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 | ( | ) |
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 12131 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 13270 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 14342 of file OSOption.cpp.
Member Data Documentation
| std::string SolverOption::name |
the name of the option
Definition at line 3349 of file OSOption.h.
| std::string SolverOption::value |
the value of the option
Definition at line 3352 of file OSOption.h.
| std::string SolverOption::solver |
the solver to which the option applies
Definition at line 3355 of file OSOption.h.
| std::string SolverOption::category |
the category to which the option belongs
Definition at line 3358 of file OSOption.h.
| std::string SolverOption::type |
the type of the option value (integer, double, boolean, string)
Definition at line 3361 of file OSOption.h.
| std::string SolverOption::description |
the description of the option
Definition at line 3364 of file OSOption.h.
| int SolverOption::numberOfItems |
the number of items (additional pieces of data) of the option
Definition at line 3367 of file OSOption.h.
| 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:
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
- /tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp
