Optika GUI Toolik Version of the Day
Public Member Functions | Protected Attributes
Optika::ArrayValidator Class Reference

#include <Optika_SpecificParameterEntryValidators.hpp>

Inheritance diagram for Optika::ArrayValidator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ArrayValidator (Teuchos::RCP< Teuchos::ParameterEntryValidator > prototypeValidator)
virtual Teuchos::RCP< const
Teuchos::Array< std::string > > 
validStringValues () const
virtual void validate (Teuchos::ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const =0
virtual void printDoc (std::string const &docString, std::ostream &out) const =0

Protected Attributes

Teuchos::RCP
< Teuchos::ParameterEntryValidator
prototypeValidator

Detailed Description

An Abstract base class for all ArrayValidators

Definition at line 646 of file Optika_SpecificParameterEntryValidators.hpp.


Constructor & Destructor Documentation

Optika::ArrayValidator::ArrayValidator ( Teuchos::RCP< Teuchos::ParameterEntryValidator prototypeValidator) [inline]

Constructs a ArrayValidator.

Parameters:
prototypeValidatorThe validator to be used on each entry in the array.

Definition at line 654 of file Optika_SpecificParameterEntryValidators.hpp.


Member Function Documentation

virtual Teuchos::RCP<const Teuchos::Array<std::string> > Optika::ArrayValidator::validStringValues ( ) const [inline, virtual]
virtual void Optika::ArrayValidator::validate ( Teuchos::ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [pure virtual]
virtual void Optika::ArrayValidator::printDoc ( std::string const &  docString,
std::ostream &  out 
) const [pure virtual]

Member Data Documentation

The prototype validator to be applied to each entry in the Array.

Definition at line 666 of file Optika_SpecificParameterEntryValidators.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends