Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions
Teuchos::ParameterEntryValidator Class Reference

Abstract interface for an object that can validate a ParameterEntry's value. More...

#include <Teuchos_ParameterEntryValidator.hpp>

Inheritance diagram for Teuchos::ParameterEntryValidator:
Inheritance graph

List of all members.

Public Member Functions

 ParameterEntryValidator ()
 Default Constructor.
virtual const std::string getXMLTypeName () const =0
 Get a string that should be used as a value of the type attribute when serializing it to XML.
virtual void printDoc (std::string const &docString, std::ostream &out) const =0
 Print documentation for this parameter.
virtual ValidStringsList validStringValues () const =0
 Return an array of strings of valid values if applicable.
virtual void validate (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const =0
 Validate a parameter entry value and throw std::exception (with a great error message) if validation fails.
virtual void validateAndModify (std::string const &paramName, std::string const &sublistName, ParameterEntry *entry) const
 Validate and perhaps modify a parameter entry's value.

Public types

typedef unsigned int ValidatorID
typedef RCP< const Array
< std::string > > 

Detailed Description

Abstract interface for an object that can validate a ParameterEntry's value.

Not only can a validator validate and entry but it can also help to set and/or adjust the default value.

Definition at line 64 of file Teuchos_ParameterEntryValidator.hpp.

Member Typedef Documentation

Definition at line 72 of file Teuchos_ParameterEntryValidator.hpp.

Definition at line 75 of file Teuchos_ParameterEntryValidator.hpp.

Constructor & Destructor Documentation

Teuchos::ParameterEntryValidator::ParameterEntryValidator ( ) [inline]

Default Constructor.

Definition at line 80 of file Teuchos_ParameterEntryValidator.hpp.

Member Function Documentation

virtual const std::string Teuchos::ParameterEntryValidator::getXMLTypeName ( ) const [pure virtual]
virtual void Teuchos::ParameterEntryValidator::printDoc ( std::string const &  docString,
std::ostream &  out 
) const [pure virtual]
virtual ValidStringsList Teuchos::ParameterEntryValidator::validStringValues ( ) const [pure virtual]
virtual void Teuchos::ParameterEntryValidator::validate ( ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [pure virtual]
virtual void Teuchos::ParameterEntryValidator::validateAndModify ( std::string const &  paramName,
std::string const &  sublistName,
ParameterEntry entry 
) const [inline, virtual]

Validate and perhaps modify a parameter entry's value.

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.
entry[in/out] The ParameterEntry who's type and value is being validated and perhaps even changed as a result of calling this function.

The default implementation simply calls this->validate().

Reimplemented in Teuchos::AnyNumberParameterEntryValidator.

Definition at line 146 of file Teuchos_ParameterEntryValidator.hpp.

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