the OtherVariableOption class. More...
#include <OSOption.h>
Public Member Functions | |
| OtherVariableOption () | |
| Default constructor. More... | |
| ~OtherVariableOption () | |
| Class destructor. More... | |
| bool | IsEqual (OtherVariableOption *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 (OtherVariableOption *that) |
| A function to make a deep copy of an instance of this class. More... | |
| bool | setVar (int numberOfVar, OtherVarOption **var) |
| A function to set an array of elements. More... | |
| bool | addVar (int idx, std::string value, std::string lbValue, std::string ubValue) |
| A function to add a element. More... | |
Public Attributes | |
| int | numberOfVar |
| number of child elements More... | |
| int | numberOfEnumerations |
| number of <enumeration> child elements More... | |
| std::string | name |
| name of the option More... | |
| std::string | value |
| value of the option More... | |
| std::string | solver |
| name of the solver to which this option applies More... | |
| std::string | category |
| name of the category into which this option falls More... | |
| std::string | type |
| type of the option value (integer, double, boolean, string) More... | |
| std::string | description |
| description of the option More... | |
| OtherVarOption ** | var |
| array of option values More... | |
| std::string | varType |
| type of the values in the var array More... | |
| OtherOptionOrResultEnumeration ** | enumeration |
| std::string | enumType |
| type of the values in the enumeration array More... | |
Detailed Description
the OtherVariableOption class.
- Remarks
- A data structure class that corresponds to an xml element in the OSoL schema.
Definition at line 1989 of file OSOption.h.
Constructor & Destructor Documentation
| OtherVariableOption::OtherVariableOption | ( | ) |
Default constructor.
Definition at line 692 of file OSOption.cpp.
| OtherVariableOption::~OtherVariableOption | ( | ) |
Class destructor.
Definition at line 712 of file OSOption.cpp.
Member Function Documentation
| bool OtherVariableOption::IsEqual | ( | OtherVariableOption * | that | ) |
A function to check for the equality of two objects.
Definition at line 11206 of file OSOption.cpp.
| bool OtherVariableOption::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 12816 of file OSOption.cpp.
| bool OtherVariableOption::deepCopyFrom | ( | OtherVariableOption * | 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 13928 of file OSOption.cpp.
| bool OtherVariableOption::setVar | ( | int | numberOfVar, |
| OtherVarOption ** | var | ||
| ) |
A function to set an array of elements.
- Parameters
-
numberOfVar,: number of elements to be set var,: the array of elements that are to be set
Definition at line 5910 of file OSOption.cpp.
| bool OtherVariableOption::addVar | ( | int | idx, |
| std::string | value, | ||
| std::string | lbValue, | ||
| std::string | ubValue | ||
| ) |
A function to add a element.
- Parameters
-
idx,: the index of the variable value,: the value associated with this variable lbValue,: a lower bound associated with this variable ubValue,: an upper bound associated with this variable
Definition at line 5948 of file OSOption.cpp.
Member Data Documentation
| int OtherVariableOption::numberOfVar |
number of child elements
Definition at line 1994 of file OSOption.h.
| int OtherVariableOption::numberOfEnumerations |
number of <enumeration> child elements
Definition at line 1997 of file OSOption.h.
| std::string OtherVariableOption::name |
name of the option
Definition at line 2000 of file OSOption.h.
| std::string OtherVariableOption::value |
value of the option
Definition at line 2003 of file OSOption.h.
| std::string OtherVariableOption::solver |
name of the solver to which this option applies
Definition at line 2006 of file OSOption.h.
| std::string OtherVariableOption::category |
name of the category into which this option falls
Definition at line 2009 of file OSOption.h.
| std::string OtherVariableOption::type |
type of the option value (integer, double, boolean, string)
Definition at line 2012 of file OSOption.h.
| std::string OtherVariableOption::description |
description of the option
Definition at line 2015 of file OSOption.h.
| OtherVarOption** OtherVariableOption::var |
array of option values
Definition at line 2018 of file OSOption.h.
| std::string OtherVariableOption::varType |
type of the values in the var array
Definition at line 2021 of file OSOption.h.
| OtherOptionOrResultEnumeration** OtherVariableOption::enumeration |
Definition at line 2027 of file OSOption.h.
| std::string OtherVariableOption::enumType |
type of the values in the enumeration array
Definition at line 2030 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
