Optika GUI Toolik Version of the Day
Public Types | Public Member Functions | Private Attributes
Optika::StringValidator Class Reference

#include <Optika_SpecificParameterEntryValidators.hpp>

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

List of all members.

Public Types

typedef Teuchos::Array
< std::string > 
ValueList

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

Private Attributes

ValueList validStrings

Detailed Description

A simple validator that only allows certain string values to be choosen.

Definition at line 614 of file Optika_SpecificParameterEntryValidators.hpp.


Member Typedef Documentation

Definition at line 616 of file Optika_SpecificParameterEntryValidators.hpp.


Constructor & Destructor Documentation

Optika::StringValidator::StringValidator ( ValueList  validStrings)

Constructs a StringValidator.

Definition at line 90 of file Optika_SpecificParameterEntryValidators.cpp.


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.

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

Definition at line 94 of file Optika_SpecificParameterEntryValidators.cpp.

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

Member Data Documentation

An array containing a list of all the valid string values.

Definition at line 640 of file Optika_SpecificParameterEntryValidators.hpp.


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