Patterns::Selection Class Reference

Inheritance diagram for Patterns::Selection:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 Selection (const std::string &seq)
virtual bool match (const std::string &test_string) const
virtual std::string description () const
virtual PatternBaseclone () const
unsigned int memory_consumption () const

Private Attributes

std::string sequence


Detailed Description

Test for the string being one of a sequence of values given like a regular expression. For example, if the string given to the constructor is "red|blue|black", then the match function returns true exactly if the string is either "red" or "blue" or "black". Spaces around the pipe signs do not matter and are eliminated.

Constructor & Destructor Documentation

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

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


Member Function Documentation

virtual bool Patterns::Selection::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::Selection::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::Selection::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.

Reimplemented in Patterns::Bool.

unsigned int Patterns::Selection::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::Selection::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.


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

deal.II documentation generated on Sat Aug 15 16:52:42 2009 by doxygen 1.5.9