Teuchos - Trilinos Tools Package  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::ParameterEntryValidator Class Referenceabstract

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

#include <Teuchos_ParameterEntryValidator.hpp>

Inheritance diagram for Teuchos::ParameterEntryValidator:
Teuchos::Describable Teuchos::LabeledObject Teuchos::AbstractArrayValidator< EnhancedNumberValidator< T >, T > Teuchos::AbstractArrayValidator< FileNameValidator, std::string > Teuchos::AbstractArrayValidator< StringValidator, std::string > Teuchos::StringToIntegralParameterEntryValidator< int > Teuchos::AbstractArrayValidator< ValidatorType, EntryType > Teuchos::AnyNumberParameterEntryValidator Teuchos::BoolParameterEntryValidator Teuchos::EnhancedNumberValidator< T > Teuchos::FileNameValidator Teuchos::StringToIntegralParameterEntryValidator< IntegralType > Teuchos::StringValidator

Public Types

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

Public Member Functions

 ParameterEntryValidator ()
 Default Constructor. More...
 
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. More...
 
virtual void printDoc (std::string const &docString, std::ostream &out) const =0
 Print documentation for this parameter. More...
 
virtual ValidStringsList validStringValues () const =0
 Return an array of strings of valid values if applicable. More...
 
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. 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...
 
- 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

- 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

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

Member Typedef Documentation

Definition at line 39 of file Teuchos_ParameterEntryValidator.hpp.

Definition at line 42 of file Teuchos_ParameterEntryValidator.hpp.

Constructor & Destructor Documentation

Teuchos::ParameterEntryValidator::ParameterEntryValidator ( )
inline

Default Constructor.

Definition at line 47 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
inlinevirtual

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::EnhancedNumberValidator< T >, Teuchos::AnyNumberParameterEntryValidator, and Teuchos::BoolParameterEntryValidator.

Definition at line 113 of file Teuchos_ParameterEntryValidator.hpp.


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