Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions
Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR Class Reference
Inheritance diagram for Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void printDoc (const std::string &docString, std::ostream &out) const
 Print documentation for this parameter.
ValidStringsList validStringValues () const
 Return an array of strings of valid values if applicable.
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.
const std::string getXMLTypeName () const
 Get a string that should be used as a value of the type attribute when serializing it to XML.

Detailed Description

Definition at line 58 of file Validator_SerializationTest.cpp.


Member Function Documentation

void Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::printDoc ( const std::string &  docString,
std::ostream &  out 
) const [inline, virtual]

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 63 of file Validator_SerializationTest.cpp.

ValidStringsList Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::validStringValues ( ) const [inline, virtual]

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 65 of file Validator_SerializationTest.cpp.

void Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::validate ( ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [inline, virtual]

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 69 of file Validator_SerializationTest.cpp.

const std::string Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR::getXMLTypeName ( ) const [inline, virtual]

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 75 of file Validator_SerializationTest.cpp.


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