Class uesd to validate a particular type of number. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::EnhancedNumberValidator< T >:

Public Member Functions
Constructors/Destructor
	EnhancedNumberValidator (T min, T max, T step=EnhancedNumberTraits< T >::defaultStep(), unsigned short precision=EnhancedNumberTraits< T >::defaultPrecision())
	Constructs a EnhancedNumberValidator.

	EnhancedNumberValidator ()
	Constructs a EnhancedNumberValidator without an explicit minimum or maximum.

Setter Functions
void	setMin (T min)
	Sets the minimum acceptable value for the validator.

void	setMax (T max)
	Sets the maximum acceptable value for the validator.

void	setStep (T step)
	Sets the step being used for the validator.

void	setPrecision (unsigned short precision)
	Sets the precision specified for the validator.

Getter Functions
T	getMin () const
	Gets the minimum acceptable value for the validator.

T	getMax () const
	Gets the maximum acceptable value for the validator.

T	getStep () const
	Gets the step being used for the validator.

unsigned short	getPrecision () const
	Gets the precision specified for the validator.

Attribute/Query Methods
bool	hasMin () const
	Determines whether or not the validator has a minimum value.

bool	hasMax () const
	Determines whether or not the validator has a maximum value.

Overridden from ParameterEntryValidator
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

Teuchos::any	getNumberFromString (const ParameterEntry &entry, const bool activeQuery) 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.

Public Member Functions inherited from Teuchos::Describable
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).

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

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

template<class T>
class Teuchos::EnhancedNumberValidator< T >

Class uesd to validate a particular type of number.

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

Definition at line 1356 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

◆ EnhancedNumberValidator() [1/2]

template<class T >

Teuchos::EnhancedNumberValidator< T >::EnhancedNumberValidator	(	T	min,
		T	max,
		T	step = `EnhancedNumberTraits<T>::defaultStep()`,
		unsigned short	precision = `EnhancedNumberTraits<T>::defaultPrecision()`
	)

inline

Constructs a EnhancedNumberValidator.

Parameters

min	The minimum acceptable value for this validator.
max	The maximum acceptable value for this validator.
step	The increments at which the values being validated should be changed when incremented in a UI.
precision	The number of decimials places to which the values validated shold be compared to the min and max and the number of decimals which are displayed in a UI. This parameter is pretty much meamingless for non-floating point types.

Definition at line 1377 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ EnhancedNumberValidator() [2/2]

template<class T >

Teuchos::EnhancedNumberValidator< T >::EnhancedNumberValidator ( )

inline

Constructs a EnhancedNumberValidator without an explicit minimum or maximum.

Definition at line 1389 of file Teuchos_StandardParameterEntryValidators.hpp.

Member Function Documentation

◆ setMin()

template<class T >

void Teuchos::EnhancedNumberValidator< T >::setMin ( T min )

inline

Sets the minimum acceptable value for the validator.

Parameters

min	The desired minimum acceptable value for the validator.

Definition at line 1407 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ setMax()

template<class T >

void Teuchos::EnhancedNumberValidator< T >::setMax ( T max )

inline

Sets the maximum acceptable value for the validator.

Parameters

min	The desired maximum acceptable value for the validator.

Definition at line 1416 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ setStep()

template<class T >

void Teuchos::EnhancedNumberValidator< T >::setStep ( T step )

inline

Sets the step being used for the validator.

Parameters

The	step to be used for the validator.

Definition at line 1425 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ setPrecision()

template<class T >

void Teuchos::EnhancedNumberValidator< T >::setPrecision ( unsigned short precision )

inline

Sets the precision specified for the validator.

Parameters

The	precision specific for the validator.

Definition at line 1433 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ getMin()

template<class T >

T Teuchos::EnhancedNumberValidator< T >::getMin ( ) const

inline

Gets the minimum acceptable value for the validator.

Returns: The minimum acceptable value for the validator.

Definition at line 1446 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ getMax()

template<class T >

T Teuchos::EnhancedNumberValidator< T >::getMax ( ) const

inline

Gets the maximum acceptable value for the validator.

Returns: The maximum acceptable value for the validator.

Definition at line 1454 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ getStep()

template<class T >

T Teuchos::EnhancedNumberValidator< T >::getStep ( ) const

inline

Gets the step being used for the validator.

Returns: The step being used for the validator.

Definition at line 1462 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ getPrecision()

template<class T >

unsigned short Teuchos::EnhancedNumberValidator< T >::getPrecision ( ) const

inline

Gets the precision specified for the validator.

Returns: The precision specific for the validator.

Definition at line 1470 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ hasMin()

template<class T >

bool Teuchos::EnhancedNumberValidator< T >::hasMin ( ) const

inline

Determines whether or not the validator has a minimum value.

Returns: True if the validator has a minimum value, false otherwise.

Definition at line 1483 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ hasMax()

template<class T >

bool Teuchos::EnhancedNumberValidator< T >::hasMax ( ) const

inline

Determines whether or not the validator has a maximum value.

Returns: True if the validator has a maximum value, false otherwise.

Definition at line 1491 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ validStringValues()

template<class T >

ValidStringsList Teuchos::EnhancedNumberValidator< T >::validStringValues ( ) const

inlinevirtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 1501 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ validate()

template<class T >

void Teuchos::EnhancedNumberValidator< T >::validate	(	ParameterEntry const &	entry,
		std::string const &	paramName,
		std::string const &	sublistName
	)		const

virtual

Implements Teuchos::ParameterEntryValidator.

Definition at line 1648 of file Teuchos_StandardParameterEntryValidators.hpp.

◆ validateAndModify()

template<class T >

void Teuchos::EnhancedNumberValidator< T >::validateAndModify	(	std::string const &	paramName,
		std::string const &	sublistName,
		ParameterEntry *	entry
	)		const