Teuchos - Trilinos Tools Package
Version of the Day
|
An abstract base class for all ArrayValidators. More...
#include <Teuchos_StandardParameterEntryValidators.hpp>
Public Member Functions | |
Constructors | |
AbstractArrayValidator (RCP< const ValidatorType > prototypeValidator) | |
Constructs an AbstractArrayValidator. More... | |
Getter Functions | |
RCP< const ValidatorType > | getPrototype () const |
Returns the prototype validator for this Array Validator. More... | |
Overridden from ParameterEntryValidator | |
ValidStringsList | validStringValues () const |
Public Member Functions inherited from Teuchos::ParameterEntryValidator | |
ParameterEntryValidator () | |
Default Constructor. More... | |
virtual const std::string | getXMLTypeName () const =0 |
Get a string that should be used as a value of the type attribute when serializing it to XML. More... | |
virtual void | printDoc (std::string const &docString, std::ostream &out) const =0 |
Print documentation for this parameter. More... | |
virtual void | validate (ParameterEntry const &entry, std::string const ¶mName, std::string const &sublistName) const =0 |
Validate a parameter entry value and throw std::exception (with a great error message) if validation fails. More... | |
virtual void | validateAndModify (std::string const ¶mName, 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... | |
An abstract base class for all ArrayValidators.
Definition at line 1956 of file Teuchos_StandardParameterEntryValidators.hpp.
|
inline |
Constructs an AbstractArrayValidator.
prototypeValidator | The prototype validator to be applied to each entry in the array. |
Definition at line 1969 of file Teuchos_StandardParameterEntryValidators.hpp.
|
inline |
Returns the prototype validator for this Array Validator.
Definition at line 1979 of file Teuchos_StandardParameterEntryValidators.hpp.
|
inlinevirtual |
Implements Teuchos::ParameterEntryValidator.
Definition at line 1989 of file Teuchos_StandardParameterEntryValidators.hpp.