Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::AbstractArrayValidator< ValidatorType, EntryType > Class Template Reference

An abstract base class for all ArrayValidators. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::AbstractArrayValidator< ValidatorType, EntryType >:
Teuchos::ParameterEntryValidator Teuchos::Describable Teuchos::LabeledObject Teuchos::ArrayValidator< ValidatorType, EntryType > Teuchos::TwoDArrayValidator< ValidatorType, EntryType >

Public Member Functions

Constructors
 AbstractArrayValidator (RCP< const ValidatorType > prototypeValidator)
 Constructs an AbstractArrayValidator. More...
 
Getter Functions
RCP< const ValidatorType > getPrototype () const
 Returns the prototype validator for this Array Validator. More...
 
Overridden from ParameterEntryValidator
ValidStringsList validStringValues () const
 
- Public Member Functions inherited from Teuchos::ParameterEntryValidator
 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 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

- Public Types inherited from Teuchos::ParameterEntryValidator
typedef unsigned int ValidatorID
 
typedef RCP< const Array
< std::string > > 
ValidStringsList
 
- 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

template<class ValidatorType, class EntryType>
class Teuchos::AbstractArrayValidator< ValidatorType, EntryType >

An abstract base class for all ArrayValidators.

Definition at line 1967 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

template<class ValidatorType, class EntryType>
Teuchos::AbstractArrayValidator< ValidatorType, EntryType >::AbstractArrayValidator ( RCP< const ValidatorType >  prototypeValidator)
inline

Constructs an AbstractArrayValidator.

Parameters
prototypeValidatorThe prototype validator to be applied to each entry in the array.

Definition at line 1980 of file Teuchos_StandardParameterEntryValidators.hpp.

Member Function Documentation

template<class ValidatorType, class EntryType>
RCP<const ValidatorType> Teuchos::AbstractArrayValidator< ValidatorType, EntryType >::getPrototype ( ) const
inline

Returns the prototype validator for this Array Validator.

Definition at line 1990 of file Teuchos_StandardParameterEntryValidators.hpp.

template<class ValidatorType, class EntryType>
ValidStringsList Teuchos::AbstractArrayValidator< ValidatorType, EntryType >::validStringValues ( ) const
inlinevirtual

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