Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::StringValidator Class Reference

A simple validator that only allows certain string values to be choosen or simply enforces that a particular parameter have a std::string for a value. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

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

Constructors/Destructor

 StringValidator ()
 Constructs a StringValidator. More...
 
 StringValidator (const Teuchos::Array< std::string > &validStrings)
 Constructs a StringValidator. More...
 

Setter Functions

ValidStringsList setValidStrings (const Teuchos::Array< std::string > &validStrings)
 Sets the Array of valid strings and returns what the current array of valid string now is. More...
 

Overridden from ParameterEntryValidator

ValidStringsList validStringValues () const
 
void validate (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
 
const std::string getXMLTypeName () const
 
void printDoc (std::string const &docString, std::ostream &out) const
 

Private Members

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

Additional Inherited Members

- Public Types inherited from Teuchos::ParameterEntryValidator
typedef unsigned int ValidatorID
 
typedef RCP< const Array
< std::string > > 
ValidStringsList
 
- Public Member Functions inherited from Teuchos::ParameterEntryValidator
 ParameterEntryValidator ()
 Default Constructor. More...
 
virtual void validateAndModify (std::string const &paramName, std::string const &sublistName, ParameterEntry *entry) const
 Validate and perhaps modify a parameter entry's value. More...
 
double convertStringToDouble (std::string str) const
 
int convertStringToInt (std::string str) const
 
int convertStringToLongLong (std::string str) const
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream. More...
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream. More...
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes). More...
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label. More...
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject). More...
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject). More...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

Detailed Description

A simple validator that only allows certain string values to be choosen or simply enforces that a particular parameter have a std::string for a value.

Please see StringValidatorXMLConverter for documenation regarding the XML representation of this validator.

Definition at line 1867 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

Teuchos::StringValidator::StringValidator ( )

Constructs a StringValidator.

Definition at line 613 of file Teuchos_StandardParameterEntryValidators.cpp.

Teuchos::StringValidator::StringValidator ( const Teuchos::Array< std::string > &  validStrings)

Constructs a StringValidator.

Parameters
validStringsA list of valid string values for this validator.

Definition at line 618 of file Teuchos_StandardParameterEntryValidators.cpp.

Member Function Documentation

ParameterEntryValidator::ValidStringsList Teuchos::StringValidator::setValidStrings ( const Teuchos::Array< std::string > &  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 625 of file Teuchos_StandardParameterEntryValidators.cpp.

ParameterEntryValidator::ValidStringsList Teuchos::StringValidator::validStringValues ( ) const
virtual
void Teuchos::StringValidator::validate ( ParameterEntry const &  entry,
std::string const &  paramName,
std::string const &  sublistName 
) const
virtual
const std::string Teuchos::StringValidator::getXMLTypeName ( ) const
virtual
void Teuchos::StringValidator::printDoc ( std::string const &  docString,
std::ostream &  out 
) const
virtual

Member Data Documentation

ValidStringsList Teuchos::StringValidator::validStrings_
private

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

Definition at line 1926 of file Teuchos_StandardParameterEntryValidators.hpp.


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