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

#include <Teuchos_ParameterEntryValidator.hpp>

Inheritance diagram for Teuchos::ParameterEntryValidator:

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 > >	ValidStringsList

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

typedef unsigned int Teuchos::ParameterEntryValidator::ValidatorID

Definition at line 72 of file Teuchos_ParameterEntryValidator.hpp.

typedef RCP<const Array<std::string> > Teuchos::ParameterEntryValidator::ValidStringsList

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]

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.

Implemented in Teuchos::ArrayValidator< ValidatorType, EntryType >, Teuchos::ArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::ArrayValidator< StringValidator, std::string >, Teuchos::ArrayValidator< FileNameValidator, std::string >, Teuchos::TwoDArrayValidator< ValidatorType, EntryType >, Teuchos::TwoDArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::TwoDArrayValidator< StringValidator, std::string >, Teuchos::TwoDArrayValidator< FileNameValidator, std::string >, Teuchos::StringValidator, Teuchos::FileNameValidator, Teuchos::EnhancedNumberValidator< T >, Teuchos::AnyNumberParameterEntryValidator, Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::StringToIntegralParameterEntryValidator< int >, and Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR.

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::ArrayValidator< ValidatorType, EntryType >, Teuchos::ArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::ArrayValidator< StringValidator, std::string >, Teuchos::ArrayValidator< FileNameValidator, std::string >, Teuchos::TwoDArrayValidator< ValidatorType, EntryType >, Teuchos::TwoDArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::TwoDArrayValidator< StringValidator, std::string >, Teuchos::TwoDArrayValidator< FileNameValidator, std::string >, Teuchos::StringValidator, Teuchos::FileNameValidator, Teuchos::EnhancedNumberValidator< T >, Teuchos::AnyNumberParameterEntryValidator, Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::StringToIntegralParameterEntryValidator< int >, and Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR.

virtual ValidStringsList 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::AbstractArrayValidator< ValidatorType, EntryType >, Teuchos::AbstractArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::AbstractArrayValidator< StringValidator, std::string >, Teuchos::AbstractArrayValidator< FileNameValidator, std::string >, Teuchos::StringValidator, Teuchos::FileNameValidator, Teuchos::EnhancedNumberValidator< T >, Teuchos::AnyNumberParameterEntryValidator, Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::StringToIntegralParameterEntryValidator< int >, and Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR.

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::ArrayValidator< ValidatorType, EntryType >, Teuchos::ArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::ArrayValidator< StringValidator, std::string >, Teuchos::ArrayValidator< FileNameValidator, std::string >, Teuchos::TwoDArrayValidator< ValidatorType, EntryType >, Teuchos::TwoDArrayValidator< EnhancedNumberValidator< T >, T >, Teuchos::TwoDArrayValidator< StringValidator, std::string >, Teuchos::TwoDArrayValidator< FileNameValidator, std::string >, Teuchos::StringValidator, Teuchos::FileNameValidator, Teuchos::EnhancedNumberValidator< T >, Teuchos::AnyNumberParameterEntryValidator, Teuchos::StringToIntegralParameterEntryValidator< IntegralType >, Teuchos::StringToIntegralParameterEntryValidator< int >, and Teuchos::UNDEFINED_PARAMETERENTRY_VALIDATOR.

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

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

Teuchos_ParameterEntryValidator.hpp

Public Member Functions

Public types

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation