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:

Public Member Functions
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

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...

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...

Additional Inherited Members
Public Types inherited from Teuchos::ParameterEntryValidator
typedef unsigned int	ValidatorID

typedef RCP< const Array < std::string > >	ValidStringsList

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the `verbLevel` argument of describe(). More...

Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. 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 1864 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

Teuchos::StringValidator::StringValidator ( )

Constructs a StringValidator.

Definition at line 645 of file Teuchos_StandardParameterEntryValidators.cpp.

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

Constructs a StringValidator.

Parameters

validStrings A list of valid string values for this validator.

Definition at line 650 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

validStrings What the array for the valid strings should contain.

Returns: What the arry for the valid strings now conatians.

Definition at line 657 of file Teuchos_StandardParameterEntryValidators.cpp.

ParameterEntryValidator::ValidStringsList Teuchos::StringValidator::validStringValues ( ) const

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 665 of file Teuchos_StandardParameterEntryValidators.cpp.

void Teuchos::StringValidator::validate	(	ParameterEntry const &	entry,
		std::string const &	paramName,
		std::string const &	sublistName
	)		const

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 671 of file Teuchos_StandardParameterEntryValidators.cpp.

const std::string Teuchos::StringValidator::getXMLTypeName ( ) const

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 706 of file Teuchos_StandardParameterEntryValidators.cpp.

void Teuchos::StringValidator::printDoc	(	std::string const &	docString,
		std::ostream &	out
	)		const

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 712 of file Teuchos_StandardParameterEntryValidators.cpp.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation