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

List of all members.

Constructor
	TwoDArrayValidator (RCP< const ValidatorType > prototypeValidator)
	Constructs a ArrayValidator.
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

---

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 1741 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 1752 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 1786 of file Teuchos_StandardParameterEntryValidators.hpp.

template<class ValidatorType, class EntryType>

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

(

)

const [inline, virtual]

Implements Teuchos::ParameterEntryValidator.

Definition at line 1765 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 [inline, virtual]

Implements Teuchos::ParameterEntryValidator.

Definition at line 1772 of file Teuchos_StandardParameterEntryValidators.hpp.

---

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

• Teuchos_StandardParameterEntryValidators.hpp