Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR Class Reference
Inheritance diagram for Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR:
Inheritance graph
[legend]

Public Member Functions

void printDoc (const std::string &docString, std::ostream &out) const
 Print documentation for this parameter. More...
 
ValidStringsList validStringValues () const
 Return an array of strings of valid values if applicable. More...
 
void validate (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
 Validate a parameter entry value and throw std::exception (with a great error message) if validation fails. More...
 
const std::string getXMLTypeName () const
 Get a string that should be used as a value of the type attribute when serializing it to XML. More...
 
- Public Member Functions inherited from Teuchos::ParameterEntryValidator
 ParameterEntryValidator ()
 Default Constructor. More...
 
virtual void validateAndModify (std::string const &paramName, std::string const &sublistName, ParameterEntry *entry) const
 Validate and perhaps modify a parameter entry's value. More...
 
double convertStringToDouble (std::string str) const
 
int convertStringToInt (std::string str) const
 
int convertStringToLongLong (std::string str) const
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 

Additional Inherited Members

- Public Types inherited from Teuchos::ParameterEntryValidator
typedef unsigned int ValidatorID
 
typedef RCP< const Array
< std::string > > 
ValidStringsList
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

Detailed Description

Definition at line 27 of file Validator_SerializationTest.cpp.

Member Function Documentation

void Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::printDoc ( const std::string &  docString,
std::ostream &  out 
) const
inlinevirtual

Print documentation for this parameter.

Parameters
docString[in] (Multi-line) documentation std::string.
out[out] The std::ostream used for the output

The purpose of this function is to augment what is in docString with some description of what valid values this parameter validator will accept.

Implements Teuchos::ParameterEntryValidator.

Definition at line 32 of file Validator_SerializationTest.cpp.

ValidStringsList Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::validStringValues ( ) const
inlinevirtual

Return an array of strings of valid values if applicable.

If there is no such array of std::string values that makes since, just return return.get()==NULL.

The returned strings must not contain any newlines (i.e. no '
'
characters) and must be short enough to fit on one line and be readable.

Implements Teuchos::ParameterEntryValidator.

Definition at line 34 of file Validator_SerializationTest.cpp.

void Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::validate ( ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const
inlinevirtual

Validate a parameter entry value and throw std::exception (with a great error message) if validation fails.

Parameters
entry[in] The ParameterEntry who's type and value is being validated
paramName[in] The name of the ParameterEntry that is used to build error messages.
sublistName[in] The name of the ParameterList that paramName exists in that is used to build error messages.

Implements Teuchos::ParameterEntryValidator.

Definition at line 38 of file Validator_SerializationTest.cpp.

const std::string Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::getXMLTypeName ( ) const
inlinevirtual

Get a string that should be used as a value of the type attribute when serializing it to XML.

Returns
a string that should be used as a tag for this validator when serializing it to XML.

Implements Teuchos::ParameterEntryValidator.

Definition at line 44 of file Validator_SerializationTest.cpp.


The documentation for this class was generated from the following file: