Reference documentation for deal.II version 8.1.0
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
Patterns::MultipleSelection Class Reference

#include <parameter_handler.h>

Inheritance diagram for Patterns::MultipleSelection:
[legend]

Public Member Functions

 MultipleSelection (const std::string &seq)
 
virtual bool match (const std::string &test_string) const
 
virtual std::string description () const
 
virtual PatternBaseclone () const
 
std::size_t memory_consumption () const
 
 DeclException1 (ExcCommasNotAllowed, int,<< "A comma was found at position "<< arg1<< " of your input string, but commas are not allowed here.")
 
- Public Member Functions inherited from Patterns::PatternBase
virtual ~PatternBase ()
 

Static Public Member Functions

static MultipleSelectioncreate (const std::string &description)
 

Private Attributes

std::string sequence
 

Static Private Attributes

static const char * description_init
 

Detailed Description

This class is much like the Selection class, but it allows the input to be a comma-separated list of values which each have to be given in the constructor argument. Alternatively, it could be viewed as a specialization of the List class. For example, if the string to the constructor was "ucd|gmv|eps", then the following would be legal input: eps, gmv. You may give an arbitrarily long list of values, where there may be as many spaces around commas as you like. However, commas are not allowed inside the values given to the constructor.

Definition at line 604 of file parameter_handler.h.

Constructor & Destructor Documentation

Patterns::MultipleSelection::MultipleSelection ( const std::string &  seq)

Constructor. Take the given parameter as the specification of valid strings.

Member Function Documentation

virtual bool Patterns::MultipleSelection::match ( const std::string &  test_string) const
virtual

Return true if the string is an element of the description list passed to the constructor.

Implements Patterns::PatternBase.

virtual std::string Patterns::MultipleSelection::description ( ) const
virtual

Return a description of the pattern that valid strings are expected to match. Here, this is the list of valid strings passed to the constructor.

Implements Patterns::PatternBase.

virtual PatternBase* Patterns::MultipleSelection::clone ( ) const
virtual

Return a copy of the present object, which is newly allocated on the heap. Ownership of that object is transferred to the caller of this function.

Implements Patterns::PatternBase.

static MultipleSelection* Patterns::MultipleSelection::create ( const std::string &  description)
static

Creates new object if the start of description matches description_init. Ownership of that object is transferred to the caller of this function.

std::size_t Patterns::MultipleSelection::memory_consumption ( ) const
virtual

Determine an estimate for the memory consumption (in bytes) of this object.

Reimplemented from Patterns::PatternBase.

Member Data Documentation

std::string Patterns::MultipleSelection::sequence
private

List of valid strings as passed to the constructor. We don't make this string constant, as we process it somewhat in the constructor.

Definition at line 662 of file parameter_handler.h.

const char* Patterns::MultipleSelection::description_init
staticprivate

Initial part of description

Definition at line 667 of file parameter_handler.h.


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