Reference documentation for deal.II version Git 4a360c6 2017-05-26 05:30:59 +0200
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
Patterns::Selection Class Reference

#include <deal.II/base/parameter_handler.h>

Inheritance diagram for Patterns::Selection:

Public Member Functions

 Selection (const std::string &seq)
virtual bool match (const std::string &test_string) const
virtual std::string description (const OutputStyle style=Machine) const
virtual PatternBaseclone () const
std::size_t memory_consumption () const
- Public Member Functions inherited from Patterns::PatternBase
virtual ~PatternBase ()

Static Public Member Functions

static Selectioncreate (const std::string &description)

Private Attributes

std::string sequence

Static Private Attributes

static const char * description_init = "[Selection"

Additional Inherited Members

- Public Types inherited from Patterns::PatternBase
enum  OutputStyle { Machine, Text, LaTeX }

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.

Definition at line 331 of file parameter_handler.h.

Constructor & Destructor Documentation

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

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

Definition at line 456 of file

Member Function Documentation

bool Patterns::Selection::match ( const std::string &  test_string) const

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

Implements Patterns::PatternBase.

Definition at line 467 of file

std::string Patterns::Selection::description ( const OutputStyle  style = Machine) const

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.

Reimplemented in Patterns::Bool.

Definition at line 498 of file

PatternBase * Patterns::Selection::clone ( ) const

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.

Definition at line 534 of file

std::size_t Patterns::Selection::memory_consumption ( ) const

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

Reimplemented from Patterns::PatternBase.

Definition at line 541 of file

Selection * Patterns::Selection::create ( const std::string &  description)

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

Definition at line 549 of file

Member Data Documentation

std::string Patterns::Selection::sequence

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 378 of file parameter_handler.h.

const char * Patterns::Selection::description_init = "[Selection"

Initial part of description

Definition at line 383 of file parameter_handler.h.

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