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:

Teuchos::AnyNumberParameterEntryValidator Teuchos::StringToIntegralParameterEntryValidator< IntegralType > List of all members.

Public Member Functions

virtual ~ParameterEntryValidator ()
 
virtual void printDoc (std::string const &docString, std::ostream &out) const =0
 Print documentation for this parameter.
virtual Teuchos::RCP< const
Array< std::string > > 
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.

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 50 of file Teuchos_ParameterEntryValidator.hpp.


Constructor & Destructor Documentation

virtual Teuchos::ParameterEntryValidator::~ParameterEntryValidator (  )  [inline, virtual]

Definition at line 54 of file Teuchos_ParameterEntryValidator.hpp.


Member Function Documentation

virtual void Teuchos::ParameterEntryValidator::printDoc ( std::string const &  docString,
std::ostream &  out 
) const [pure 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.

Implemented in Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::AnyNumberParameterEntryValidator, and Teuchos::StringToIntegralParameterEntryValidator< int >.

virtual Teuchos::RCP<const Array<std::string> > Teuchos::ParameterEntryValidator::validStringValues (  )  const [pure 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.

Implemented in Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::AnyNumberParameterEntryValidator, and Teuchos::StringToIntegralParameterEntryValidator< int >.

virtual void Teuchos::ParameterEntryValidator::validate ( ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [pure 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.

Implemented in Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::AnyNumberParameterEntryValidator, and Teuchos::StringToIntegralParameterEntryValidator< int >.

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.

Parameters:
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 113 of file Teuchos_ParameterEntryValidator.hpp.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:24:43 2010 for Teuchos - Trilinos Tools Package by  doxygen 1.4.7