Panzer Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
panzer::CommaSeparatedEntryValidator Class Reference

#include <Panzer_CommaSeparatedEntryValidator.hpp>

Inherits Teuchos::ParameterEntryValidator.

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
 

Static Public Member Functions

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

Private Attributes

bool allowEmpty_
 

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

◆ CommaSeparatedEntryValidator()

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

◆ validStringValues()

ValidStringsList panzer::CommaSeparatedEntryValidator::validStringValues ( ) const
inline

Definition at line 70 of file Panzer_CommaSeparatedEntryValidator.hpp.

◆ validate()

void panzer::CommaSeparatedEntryValidator::validate ( const Teuchos::ParameterEntry & entry,
const std::string & paramName,
const std::string & sublistName ) const

Definition at line 74 of file Panzer_CommaSeparatedEntryValidator.cpp.

◆ getXMLTypeName()

const std::string panzer::CommaSeparatedEntryValidator::getXMLTypeName ( ) const
inline

Definition at line 77 of file Panzer_CommaSeparatedEntryValidator.hpp.

◆ printDoc()

void panzer::CommaSeparatedEntryValidator::printDoc ( const std::string & docString,
std::ostream & out ) const

Definition at line 112 of file Panzer_CommaSeparatedEntryValidator.cpp.

◆ split()

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 49 of file Panzer_CommaSeparatedEntryValidator.cpp.

Member Data Documentation

◆ allowEmpty_

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: