Teuchos - Trilinos Tools Package Version of the Day
Related Functions
Teuchos::ParameterEntry Class Reference

This object is held as the "value" in the Teuchos::ParameterList std::map. More...

#include <Teuchos_ParameterEntry.hpp>

List of all members.

Public Types

Public types
typedef unsigned int ParameterEntryID
 

Public Member Functions

Constructors/Destructor
 ParameterEntry ()
 Default Constructor.
 ParameterEntry (const ParameterEntry &source)
 Copy constructor.
template<typename T >
 ParameterEntry (T value, bool isDefault=false, bool isList=false, const std::string &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 Templated constructor.
Set Methods
ParameterEntryoperator= (const ParameterEntry &source)
 Replace the current parameter entry with source.
template<typename T >
void setValue (T value, bool isDefault=false, const std::string &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 Templated set method that uses the input value type to determine the type of parameter.
void setAnyValue (const any &value, bool isDefault=false)
 Set the value as an any object.
void setValidator (RCP< const ParameterEntryValidator > const &validator)
 Set the validator.
void setDocString (const std::string &docString)
 Set the documentation std::string.
ParameterListsetList (bool isDefault=false, const std::string &docString="")
 Create a parameter entry that is an empty list.
Get Methods
template<typename T >
T & getValue (T *ptr) const
 Templated get method that uses the input pointer type to determine the type of parameter to return.
anygetAny (bool activeQry=true)
 Direct access to the Teuchos::any data value underlying this object. The bool argument activeQry (default: true) indicates that the call to getAny() will set the isUsed() value of the ParameterEntry to true.
const anygetAny (bool activeQry=true) const
 Constant direct access to the Teuchos::any data value underlying this object. The bool argument activeQry (default: true) indicates that the call to getAny() will set the isUsed() value of the ParameterEntry to true.
Attribute/Query Methods
bool isUsed () const
 Return whether or not the value has been used; i.e., whether or not the value has been retrieved via a get function.
bool isList () const
 Return whether or not the value itself is a list.
template<typename T >
bool isType () const
 Test the type of the data being contained.
bool isArray () const
 Test if the type of data being contained is a Teuchos::Array.
bool isTwoDArray () const
 Test if the type of data being contained is a Teuchos::TwoDArray.
bool isDefault () const
 Indicate whether this entry takes on the default value.
std::string docString () const
 Return the (optional) documentation std::string.
RCP< const
ParameterEntryValidator
validator () const
 Return the (optional) validator object.

Related Functions

(Note that these are not member functions.)

template<typename T >
T & getValue (const ParameterEntry &entry)
 A templated helper function for returning the value of type T held in the ParameterEntry object, where the type T can be specified in the call. This is an easier way to call the getValue method in the ParameterEntry class, since the user does not have to pass in a pointer of type T.
template<typename T >
T & getValue (RCP< const ParameterEntry > entry)
 A templated helper function for returning the value of type T held in the ParameterEntry object, where the type T can be specified in the call. This is an easier way to call the getValue method in the ParameterEntry class, since the user does not have to pass in a pointer of type T.
bool operator== (const ParameterEntry &e1, const ParameterEntry &e2)
 Returns true if two ParameterEntry objects are equal.
bool operator!= (const ParameterEntry &e1, const ParameterEntry &e2)
 Returns true if two ParameterEntry objects are not equal.
std::ostream & operator<< (std::ostream &os, const ParameterEntry &e)
 Output stream operator for handling the printing of parameter entries.

I/O Methods

std::ostream & leftshift (std::ostream &os, bool printFlags=true) const
 Output a non-list parameter to the given output stream.
static const std::string & getTagName ()
 Get the string that should be used as the tag name for all parameters when they are serialized to xml.

Detailed Description

This object is held as the "value" in the Teuchos::ParameterList std::map.

This structure holds a Teuchos::any value and information on the status of this parameter (isUsed, isDefault, etc.). The type of parameter is chosen through the templated Set/Get methods.

Definition at line 67 of file Teuchos_ParameterEntry.hpp.


Member Typedef Documentation

Definition at line 75 of file Teuchos_ParameterEntry.hpp.


Constructor & Destructor Documentation

Teuchos::ParameterEntry::ParameterEntry ( )

Default Constructor.

Definition at line 51 of file Teuchos_ParameterEntry.cpp.

Teuchos::ParameterEntry::ParameterEntry ( const ParameterEntry source)

Copy constructor.

Definition at line 57 of file Teuchos_ParameterEntry.cpp.

template<typename T >
Teuchos::ParameterEntry::ParameterEntry ( value,
bool  isDefault = false,
bool  isList = false,
const std::string &  docString = "",
RCP< const ParameterEntryValidator > const &  validator = null 
) [inline, explicit]

Templated constructor.

Definition at line 315 of file Teuchos_ParameterEntry.hpp.


Member Function Documentation

ParameterEntry & Teuchos::ParameterEntry::operator= ( const ParameterEntry source)

Replace the current parameter entry with source.

Definition at line 63 of file Teuchos_ParameterEntry.cpp.

template<typename T >
void Teuchos::ParameterEntry::setValue ( value,
bool  isDefault = false,
const std::string &  docString = "",
RCP< const ParameterEntryValidator > const &  validator = null 
) [inline]

Templated set method that uses the input value type to determine the type of parameter.

Note:
  • Invalidates any previous values stored by this object although it doesn't necessarily erase them.
  • Resets 'isUsed' functionality.

Definition at line 333 of file Teuchos_ParameterEntry.hpp.

void Teuchos::ParameterEntry::setAnyValue ( const any value,
bool  isDefault = false 
)

Set the value as an any object.

This wipes all other data including documentation strings.

Warning! Do not use function ths to set a sublist!

Definition at line 77 of file Teuchos_ParameterEntry.cpp.

void Teuchos::ParameterEntry::setValidator ( RCP< const ParameterEntryValidator > const &  validator)

Set the validator.

Definition at line 89 of file Teuchos_ParameterEntry.cpp.

void Teuchos::ParameterEntry::setDocString ( const std::string &  docString)

Set the documentation std::string.

Definition at line 97 of file Teuchos_ParameterEntry.cpp.

ParameterList & Teuchos::ParameterEntry::setList ( bool  isDefault = false,
const std::string &  docString = "" 
)

Create a parameter entry that is an empty list.

Definition at line 103 of file Teuchos_ParameterEntry.cpp.

template<typename T >
T & Teuchos::ParameterEntry::getValue ( T *  ptr) const [inline]

Templated get method that uses the input pointer type to determine the type of parameter to return.

Note:
This method will cast the value to the type requested. If that type is incorrect, an std::exception will be thrown by the any_cast.

Definition at line 350 of file Teuchos_ParameterEntry.hpp.

any & Teuchos::ParameterEntry::getAny ( bool  activeQry = true) [inline]

Direct access to the Teuchos::any data value underlying this object. The bool argument activeQry (default: true) indicates that the call to getAny() will set the isUsed() value of the ParameterEntry to true.

Definition at line 357 of file Teuchos_ParameterEntry.hpp.

const any & Teuchos::ParameterEntry::getAny ( bool  activeQry = true) const [inline]

Constant direct access to the Teuchos::any data value underlying this object. The bool argument activeQry (default: true) indicates that the call to getAny() will set the isUsed() value of the ParameterEntry to true.

Definition at line 366 of file Teuchos_ParameterEntry.hpp.

bool Teuchos::ParameterEntry::isUsed ( ) const [inline]

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

Definition at line 377 of file Teuchos_ParameterEntry.hpp.

bool Teuchos::ParameterEntry::isList ( ) const

Return whether or not the value itself is a list.

Definition at line 115 of file Teuchos_ParameterEntry.cpp.

template<typename T >
bool Teuchos::ParameterEntry::isType ( ) const [inline]

Test the type of the data being contained.

Definition at line 382 of file Teuchos_ParameterEntry.hpp.

bool Teuchos::ParameterEntry::isArray ( ) const

Test if the type of data being contained is a Teuchos::Array.

Definition at line 146 of file Teuchos_ParameterEntry.cpp.

bool Teuchos::ParameterEntry::isTwoDArray ( ) const

Test if the type of data being contained is a Teuchos::TwoDArray.

Definition at line 134 of file Teuchos_ParameterEntry.cpp.

bool Teuchos::ParameterEntry::isDefault ( ) const [inline]

Indicate whether this entry takes on the default value.

Definition at line 386 of file Teuchos_ParameterEntry.hpp.

std::string Teuchos::ParameterEntry::docString ( ) const [inline]

Return the (optional) documentation std::string.

Definition at line 390 of file Teuchos_ParameterEntry.hpp.

RCP< const ParameterEntryValidator > Teuchos::ParameterEntry::validator ( ) const [inline]

Return the (optional) validator object.

Definition at line 395 of file Teuchos_ParameterEntry.hpp.

std::ostream & Teuchos::ParameterEntry::leftshift ( std::ostream &  os,
bool  printFlags = true 
) const

Output a non-list parameter to the given output stream.

The parameter is followed by "[default]" if it is the default value given through a Set method. Otherwise, if the parameter was unused (not accessed through a Get method), it will be followed by "[unused]". This function is called by the "std::ostream& operator<<".

Definition at line 120 of file Teuchos_ParameterEntry.cpp.

static const std::string& Teuchos::ParameterEntry::getTagName ( ) [inline, static]

Get the string that should be used as the tag name for all parameters when they are serialized to xml.

Definition at line 220 of file Teuchos_ParameterEntry.hpp.


Friends And Related Function Documentation

template<typename T >
T & getValue ( const ParameterEntry entry) [related]

A templated helper function for returning the value of type T held in the ParameterEntry object, where the type T can be specified in the call. This is an easier way to call the getValue method in the ParameterEntry class, since the user does not have to pass in a pointer of type T.

Definition at line 263 of file Teuchos_ParameterEntry.hpp.

template<typename T >
T & getValue ( RCP< const ParameterEntry entry) [related]

A templated helper function for returning the value of type T held in the ParameterEntry object, where the type T can be specified in the call. This is an easier way to call the getValue method in the ParameterEntry class, since the user does not have to pass in a pointer of type T.

Definition at line 274 of file Teuchos_ParameterEntry.hpp.

bool operator== ( const ParameterEntry e1,
const ParameterEntry e2 
) [related]

Returns true if two ParameterEntry objects are equal.

Definition at line 282 of file Teuchos_ParameterEntry.hpp.

bool operator!= ( const ParameterEntry e1,
const ParameterEntry e2 
) [related]

Returns true if two ParameterEntry objects are not equal.

Definition at line 295 of file Teuchos_ParameterEntry.hpp.

std::ostream & operator<< ( std::ostream &  os,
const ParameterEntry e 
) [related]

Output stream operator for handling the printing of parameter entries.

Definition at line 303 of file Teuchos_ParameterEntry.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines