Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Teuchos::ArrayFileNameValidator Class Reference

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

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::ArrayFileNameValidator:

Constructors/Destructor

 ArrayFileNameValidator (RCP< const FileNameValidator > prototypeValidator)

Additional Inherited Members

typedef unsigned int ValidatorID
typedef RCP< const Array< std::string > > ValidStringsList
 ArrayValidator (RCP< const FileNameValidator > 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
 AbstractArrayValidator (RCP< const FileNameValidator > prototypeValidator)
 Constructs an AbstractArrayValidator.
RCP< const FileNameValidatorgetPrototype () 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.
double convertStringToDouble (std::string str) const
int convertStringToInt (std::string str) const
int convertStringToLongLong (std::string str) const
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).
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe().

Detailed Description

Convience class for FileNameValidators 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 I wanted to maintain consistency with the ArrayNumberValidator class which cannot be typedef'd.

Definition at line 2365 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

◆ ArrayFileNameValidator()

Teuchos::ArrayFileNameValidator::ArrayFileNameValidator ( RCP< const FileNameValidator > prototypeValidator)
inline

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