Standard implementation of a BoolParameterEntryValidator that accepts bool values (true/false) or string values for bool ("true"/"false"). More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::BoolParameterEntryValidator:

[legend]

Private Member Functions
void	finishInitialization ()

void	throwTypeError (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const

Private Attributes
std::string	acceptedTypesString_

Related Functions
(Note that these are not member functions.)
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP < BoolParameterEntryValidator >	boolParameterEntryValidator ()
	Nonmember constructor BoolParameterEntryValidator. 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...

Constructors
	BoolParameterEntryValidator ()

Local non-virtual validated lookup functions
bool	getBool (const ParameterEntry &entry, const std::string &paramName="", const std::string &sublistName="", const bool activeQuery=true) const
	Get bool value from a parameter entry. More...

bool	getBool (ParameterList &paramList, const std::string &paramName, const int defaultValue) const
	Lookup parameter from a parameter list and return as a bool value. More...

Overridden from ParameterEntryValidator
const std::string	getXMLTypeName () const

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

ValidStringsList	validStringValues () const

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

void	validateAndModify (std::string const &paramName, std::string const &sublistName, ParameterEntry *entry) const

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

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

Standard implementation of a BoolParameterEntryValidator that accepts bool values (true/false) or string values for bool ("true"/"false").

Objects of this type are meant to be used as both abstract objects passed to Teuchos::ParameterList objects to be used to validate parameter types and values, and to be used by the code that reads parameter values. Having a single definition for the types of valids input and outputs for a parameter value makes it easier to write error-free validated code.

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

Definition at line 603 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

Teuchos::BoolParameterEntryValidator::BoolParameterEntryValidator ( )

Definition at line 135 of file Teuchos_StandardParameterEntryValidators.cpp.

Member Function Documentation

bool Teuchos::BoolParameterEntryValidator::getBool	(	const ParameterEntry &	entry,
		const std::string &	paramName = `""`,
		const std::string &	sublistName = `""`,
		const bool	activeQuery = `true`
	)		const

Get bool value from a parameter entry.

Definition at line 144 of file Teuchos_StandardParameterEntryValidators.cpp.

bool Teuchos::BoolParameterEntryValidator::getBool	(	ParameterList &	paramList,
		const std::string &	paramName,
		const int	defaultValue
	)		const

Lookup parameter from a parameter list and return as a bool value.

Definition at line 168 of file Teuchos_StandardParameterEntryValidators.cpp.

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

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 180 of file Teuchos_StandardParameterEntryValidators.cpp.

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

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 185 of file Teuchos_StandardParameterEntryValidators.cpp.

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

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 196 of file Teuchos_StandardParameterEntryValidators.cpp.

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

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 202 of file Teuchos_StandardParameterEntryValidators.cpp.

void Teuchos::BoolParameterEntryValidator::validateAndModify	(	std::string const &	paramName,
		std::string const &	sublistName,
		ParameterEntry *	entry
	)		const

virtual

Reimplemented from Teuchos::ParameterEntryValidator.

Definition at line 213 of file Teuchos_StandardParameterEntryValidators.cpp.

void Teuchos::BoolParameterEntryValidator::finishInitialization ( )

private

Definition at line 227 of file Teuchos_StandardParameterEntryValidators.cpp.

void Teuchos::BoolParameterEntryValidator::throwTypeError	(	ParameterEntry const &	entry,
		std::string const &	paramName,
		std::string const &	sublistName
	)		const

private

Definition at line 237 of file Teuchos_StandardParameterEntryValidators.cpp.

Friends And Related Function Documentation

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< BoolParameterEntryValidator > boolParameterEntryValidator ( )

Member Data Documentation

std::string Teuchos::BoolParameterEntryValidator::acceptedTypesString_

private

Definition at line 671 of file Teuchos_StandardParameterEntryValidators.hpp.

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

Private Member Functions

Private Attributes

Related Functions

Constructors

Local non-virtual validated lookup functions

Overridden from ParameterEntryValidator

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation