Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Teuchos::ArrayStringValidator Class Reference

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

#include <Teuchos_StandardParameterEntryValidators.hpp>

Inheritance diagram for Teuchos::ArrayStringValidator:
Inheritance graph
[legend]

Constructors/Destructor

 ArrayStringValidator (RCP< const StringValidator > prototypeValidator)
 

Additional Inherited Members

- Public Types inherited from Teuchos::ParameterEntryValidator
typedef unsigned int ValidatorID
 
typedef RCP< const Array
< std::string > > 
ValidStringsList
 
- Public Member Functions inherited from Teuchos::ArrayValidator< StringValidator, std::string >
 ArrayValidator (RCP< const StringValidator > prototypeValidator)
 Constructs a ArrayValidator. More...
 
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< StringValidator, std::string >
 AbstractArrayValidator (RCP< const StringValidator > prototypeValidator)
 Constructs an AbstractArrayValidator. More...
 
RCP< const StringValidatorgetPrototype () const
 Returns the prototype validator for this Array Validator. More...
 
ValidStringsList validStringValues () const
 
- Public Member Functions inherited from Teuchos::ParameterEntryValidator
 ParameterEntryValidator ()
 Default Constructor. More...
 
virtual void validateAndModify (std::string const &paramName, std::string const &sublistName, ParameterEntry *entry) const
 Validate and perhaps modify a parameter entry's value. More...
 
double convertStringToDouble (std::string str) const
 
int convertStringToInt (std::string str) const
 
int convertStringToLongLong (std::string str) const
 
- 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...
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe(). More...
 

Detailed Description

Convience class for StringValidators 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 2329 of file Teuchos_StandardParameterEntryValidators.hpp.

Constructor & Destructor Documentation

Teuchos::ArrayStringValidator::ArrayStringValidator ( RCP< const StringValidator prototypeValidator)
inline

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