NOX::Parameter::Entry Class Reference

Manipulating single parameters, including sublists. More...

#include <NOX_Parameter_Entry.H>

Collaboration diagram for NOX::Parameter::Entry:

[legend]
List of all members.

Public Member Functions

 Entry ()
 Default Constructor.
 Entry (const Entry &source)
 Copy constructor.
Entryoperator= (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.

ListsetList (bool isCreatedByGet=false)
ListgetListValue ()
const ListgetListValue () 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 ArbitrarygetArbitraryValue () const

Detailed Description

Manipulating single parameters, including sublists.


Member Function Documentation

bool Entry::isUsed  )  const
 

Return whether or not the value is used; i.e., whether or not the value has been retrieved via a get function.

ostream & Entry::leftshift ostream &  stream  )  const
 

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<<.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:40:51 2008 for NOX by doxygen 1.3.9.1