Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
panzer::CommaSeparatedEntryValidator Class Reference

#include <Panzer_CommaSeparatedEntryValidator.hpp>

Inheritance diagram for panzer::CommaSeparatedEntryValidator:
Inheritance graph
[legend]

Public Member Functions

 CommaSeparatedEntryValidator (bool allowEmpty=false)
 
ValidStringsList validStringValues () const
 
void validate (const Teuchos::ParameterEntry &entry, const std::string &paramName, const std::string &sublistName) const
 
const std::string getXMLTypeName () const
 
void printDoc (const std::string &docString, std::ostream &out) const
 
- Public Member Functions inherited from Teuchos::ParameterEntryValidator
 ParameterEntryValidator ()
 
virtual void validateAndModify (std::string const &paramName, std::string const &sublistName, ParameterEntry *entry) const
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Static Public Member Functions

static void split (const std::string &str, const std::string &delim, std::vector< std::string > &tokens)
 Utility function for tokenizing. More...
 

Private Attributes

bool allowEmpty_
 

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
 

Detailed Description

This class validates a response type. Essentially it is used to make sure the parameter value is correctly formatted.

Definition at line 63 of file Panzer_CommaSeparatedEntryValidator.hpp.

Constructor & Destructor Documentation

panzer::CommaSeparatedEntryValidator::CommaSeparatedEntryValidator ( bool  allowEmpty = false)
inline

A basic constructor. If allowEmpty is true then the empty string is a valid entry.

Definition at line 68 of file Panzer_CommaSeparatedEntryValidator.hpp.

Member Function Documentation

ValidStringsList panzer::CommaSeparatedEntryValidator::validStringValues ( ) const
inlinevirtual
void panzer::CommaSeparatedEntryValidator::validate ( const Teuchos::ParameterEntry entry,
const std::string &  paramName,
const std::string &  sublistName 
) const
virtual
const std::string panzer::CommaSeparatedEntryValidator::getXMLTypeName ( ) const
inlinevirtual
void panzer::CommaSeparatedEntryValidator::printDoc ( const std::string &  docString,
std::ostream &  out 
) const
virtual
void panzer::CommaSeparatedEntryValidator::split ( const std::string &  str,
const std::string &  delim,
std::vector< std::string > &  tokens 
)
static

Utility function for tokenizing.

Definition at line 50 of file Panzer_CommaSeparatedEntryValidator.cpp.

Member Data Documentation

bool panzer::CommaSeparatedEntryValidator::allowEmpty_
private

Definition at line 88 of file Panzer_CommaSeparatedEntryValidator.hpp.


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