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:

[legend]

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

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

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.

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

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

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 1875 of file Teuchos_StandardParameterEntryValidators.hpp.