Optika Development
Public Types | Public Member Functions
Optika::StringValidator Class Reference

#include <Optika_SpecificParameterEntryValidators.hpp>

Inheritance diagram for Optika::StringValidator:
Inheritance graph
Collaboration diagram for Optika::StringValidator:
Collaboration graph

List of all members.

Public Types

typedef Teuchos::Array
< std::string > 

Public Member Functions

 StringValidator (ValueList validStrings)
const ValueList setValidStrings (ValueList validStrings)
Teuchos::RCP< const
Teuchos::Array< std::string > > 
validStringValues () 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 simple validator that only allows certain string values to be choosen.

Constructor & Destructor Documentation

Optika::StringValidator::StringValidator ( ValueList  validStrings)

Constructs a StringValidator.

Member Function Documentation

const Teuchos::Array< std::string > Optika::StringValidator::setValidStrings ( ValueList  validStrings)

Sets the Array of valid strings and returns what the current array of valid string now is.

validStringsWhat the array for the valid strings should contain.
What the arry for the valid strings now conatians.

The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations