Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Teuchos::ArrayNumberValidator< T > Class Template Reference

Convience class for EnhancedNumberValidators that are to be applied to arrays. More...

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::ArrayNumberValidator< T >:
Teuchos::ArrayValidator< EnhancedNumberValidator< T >, T > Teuchos::AbstractArrayValidator< EnhancedNumberValidator< T >, T > Teuchos::ParameterEntryValidator Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

Constructors/Destructor
 ArrayNumberValidator (RCP< const EnhancedNumberValidator< T > > prototypeValidator)
Public Member Functions inherited from Teuchos::ArrayValidator< EnhancedNumberValidator< T >, T >
 ArrayValidator (RCP< const EnhancedNumberValidator< T > > prototypeValidator)
 Constructs a ArrayValidator.
virtual void validate (ParameterEntry const &entry, std::string const &paramName, std::string const &sublistName) const
const std::string getXMLTypeName () const
virtual void printDoc (std::string const &docString, std::ostream &out) const
Public Member Functions inherited from Teuchos::AbstractArrayValidator< EnhancedNumberValidator< T >, T >
 AbstractArrayValidator (RCP< const EnhancedNumberValidator< T > > prototypeValidator)
 Constructs an AbstractArrayValidator.
RCP< const EnhancedNumberValidator< T > > getPrototype () const
 Returns the prototype validator for this Array Validator.
ValidStringsList validStringValues () const
 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.
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

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

Detailed Description

template<class T>
class Teuchos::ArrayNumberValidator< T >

Convience class for EnhancedNumberValidators that are to be applied to arrays.

Also needed for maintaining backwards compatiblitiy with the earliest versions of the Optika package. This class would be a simple typedef, however the current c++ compilers do not support templated typedefs

Definition at line 2381 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

◆ ArrayNumberValidator()

template<class T>
Teuchos::ArrayNumberValidator< T >::ArrayNumberValidator ( RCP< const EnhancedNumberValidator< T > > prototypeValidator)
inline

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