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

const std::string	getXMLTypeName () const

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

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

Constructor & Destructor Documentation

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

template<class T >

Teuchos::EnhancedNumberValidator< T >::EnhancedNumberValidator ( ) [inline]

Constructs a EnhancedNumberValidator without an explicit minimum or maximum.

Definition at line 1198 of file Teuchos_StandardParameterEntryValidators.hpp.

Member Function Documentation

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

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

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

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

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

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

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

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

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

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

template<class T >

ValidStringsList Teuchos::EnhancedNumberValidator< T >::validStringValues ( ) const [inline, virtual]

Implements Teuchos::ParameterEntryValidator.

Definition at line 1310 of file Teuchos_StandardParameterEntryValidators.hpp.

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

template<class T >

const std::string Teuchos::EnhancedNumberValidator< T >::getXMLTypeName ( ) const [inline, virtual]

Implements Teuchos::ParameterEntryValidator.

Definition at line 1319 of file Teuchos_StandardParameterEntryValidators.hpp.

template<class T >

void Teuchos::EnhancedNumberValidator< T >::printDoc	(	std::string const &	docString,
		std::ostream &	out
	)		const `[inline, virtual]`

Implements Teuchos::ParameterEntryValidator.

Definition at line 1324 of file Teuchos_StandardParameterEntryValidators.hpp.

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

Teuchos_StandardParameterEntryValidators.hpp

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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