Optika GUI Toolik Version of the Day
Public Member Functions
Optika::ArrayStringValidator Class Reference

#include <Optika_SpecificParameterEntryValidators.hpp>

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

List of all members.

Public Member Functions

 ArrayStringValidator (Teuchos::RCP< Teuchos::ParameterEntryValidator > prototypeValidator)
Teuchos::RCP< const
Teuchos::ParameterEntryValidator
getPrototype () const
void validate (Teuchos::ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
void printDoc (std::string const &docString, std::ostream &out) const

Detailed Description

A wrapper class for Arrays using a StringToIntegralParameterEntryValidator.

Definition at line 672 of file Optika_SpecificParameterEntryValidators.hpp.


Constructor & Destructor Documentation

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

Constructs an ArrayStringValidator

Parameters:
prototypeValidatorThe ParameterEntry validator containing a list of valid string values to be used on each entry in the Array.

Definition at line 680 of file Optika_SpecificParameterEntryValidators.hpp.


Member Function Documentation

Teuchos::RCP<const Teuchos::ParameterEntryValidator> Optika::ArrayStringValidator::getPrototype ( ) const [inline]

Retruns the prototype validator being used by the ArrayStringValidator.

Returns:
The prototype validator being used by the ArrayStringValidator.

Definition at line 688 of file Optika_SpecificParameterEntryValidators.hpp.

void Optika::ArrayStringValidator::validate ( Teuchos::ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const [inline, virtual]
void Optika::ArrayStringValidator::printDoc ( std::string const &  docString,
std::ostream &  out 
) const [inline, virtual]

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