Teuchos::TwoDArrayValidator< ValidatorType, EntryType > Class Template Reference

Takes a validator, wraps it, and applies it to a TwoDArray. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::TwoDArrayValidator< ValidatorType, EntryType >:

Constructor
	TwoDArrayValidator (RCP< const ValidatorType > prototypeValidator)
	Constructs a ArrayValidator. More...

Overridden from ParameterEntryValidator
virtual void	validate (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
const std::string	getXMLTypeName () const
virtual void	printDoc (std::string const &docString, std::ostream &out) const

Additional Inherited Members
Public Types inherited from Teuchos::ParameterEntryValidator
typedef unsigned int	ValidatorID
typedef RCP< const Array < std::string > >	ValidStringsList
Public Member Functions inherited from Teuchos::AbstractArrayValidator< ValidatorType, EntryType >
	AbstractArrayValidator (RCP< const ValidatorType > prototypeValidator)
	Constructs an AbstractArrayValidator. More...
RCP< const ValidatorType >	getPrototype () const
	Returns the prototype validator for this Array Validator. More...
ValidStringsList	validStringValues () const
Public Member Functions inherited from Teuchos::ParameterEntryValidator
	ParameterEntryValidator ()
	Default Constructor. 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...
double	convertStringToDouble (std::string str) const
int	convertStringToInt (std::string str) const
int	convertStringToLongLong (std::string str) const
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...
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the verbLevel argument of describe(). More...
Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. More...

Detailed Description

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

Takes a validator, wraps it, and applies it to a TwoDArray.

This class is a wrapper, allowing you to apply a normal validator to a TwoDArray of values. It is templated on both the validator type and the type of the entries contained within the array.

Please see TwoDArrayValidatorXMLConverter for documenation regarding the XML representation of this validator.

Definition at line 2024 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

template<class ValidatorType, class EntryType>

Teuchos::TwoDArrayValidator< ValidatorType, EntryType >::TwoDArrayValidator ( RCP< const ValidatorType >  prototypeValidator )

inline

Constructs a ArrayValidator.

Parameters

prototypeValidator

The validator to be used on each entry in the array.

Definition at line 2035 of file Teuchos_StandardParameterEntryValidators.hpp.

Member Function Documentation

template<class ValidatorType , class EntryType >

void Teuchos::TwoDArrayValidator< ValidatorType, EntryType >::validate ( ParameterEntry const &  entry, std::string const &  paramName, std::string const &  sublistName  ) const

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 2069 of file Teuchos_StandardParameterEntryValidators.hpp.

template<class ValidatorType, class EntryType>

const std::string Teuchos::TwoDArrayValidator< ValidatorType, EntryType >::getXMLTypeName ( ) const

inlinevirtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 2048 of file Teuchos_StandardParameterEntryValidators.hpp.

template<class ValidatorType, class EntryType>

virtual void Teuchos::TwoDArrayValidator< ValidatorType, EntryType >::printDoc ( std::string const &  docString, std::ostream &  out  ) const

inlinevirtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 2055 of file Teuchos_StandardParameterEntryValidators.hpp.

---

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

• Teuchos_StandardParameterEntryValidators.hpp