#include <NOX_Parameter_Entry.H>
Collaboration diagram for NOX::Parameter::Entry:
Public Member Functions | |
| Entry () | |
| Default Constructor. | |
| Entry (const Entry &source) | |
| Copy constructor. | |
| Entry & | operator= (const Entry &source) |
| Copy. | |
| Entry (bool value, bool isCreatedByGet=false) | |
| Bool constructor. | |
| Entry (int value, bool isCreatedByGet=false) | |
| Integer constructor. | |
| Entry (double value, bool isCreatedByGet=false) | |
| Double constructor. | |
| Entry (const string &value, bool isCreatedByGet=false) | |
| String constructor (creates its own copy of the string). | |
| Entry (const Arbitrary &value, bool isCreatedByGet=false) | |
| Arbitrary constructor (creates its own copy of the Arbitrary object). | |
| ~Entry () | |
| Destructor. | |
| bool | isUsed () const |
| ostream & | leftshift (ostream &stream) const |
| Output the parameter to the given stream. | |
ParameterList parameters | |
Functions for handling parameters that are themselves lists. | |
| List & | setList (bool isCreatedByGet=false) |
| List & | getListValue () |
| const List & | getListValue () const |
Set functions. | |
The input value type determines the type of parameter stored. Invalidates any previous values stored by this object, although it doesn't necessarily erase them. Resets 'isused' functionality. | |
| void | setValue (bool value, bool isCreatedByGet=false) |
| void | setValue (int value, bool isCreatedByGet=false) |
| void | setValue (double value, bool isCreatedByGet=false) |
| void | setValue (const char *value, bool isCreatedByGet=false) |
| void | setValue (const string &value, bool isCreatedByGet=false) |
| void | setValue (const Arbitrary &value, bool isCreatedByGet=false) |
Is functions. | |
Return true if the parameter is of the specified type; otherwise, return false. | |
| bool | isBool () const |
| bool | isInt () const |
| bool | isDouble () const |
| bool | isString () const |
| bool | isList () const |
| bool | isArbitrary () const |
Get functions. | |
Returns value of parameter. The value is nonsense if we do not request the correct type of value. We cannot name all of these functions the same since the language does not allow us to overload functions based solely on return value. | |
| bool | getBoolValue () const |
| int | getIntValue () const |
| double | getDoubleValue () const |
| const string & | getStringValue () const |
| const Arbitrary & | getArbitraryValue () const |
|
|
Return whether or not the value is used; i.e., whether or not the value has been retrieved via a get function. |
|
|
Output the parameter to the given stream. Formats the output as "<type,value>", except in the case of a list which just outputs "\<sublist\>". If the parameter has not yet been set, it outputs "\<NONE\>". This is the function called by the ostream operator<<. |
1.3.9.1