Patterns::Selection Class Reference

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

Inheritance diagram for Patterns::Selection:

Public Types
enum	OutputStyle { Machine , Text , LaTeX }

Public Member Functions
	Selection (const std::string &seq)
virtual bool	match (const std::string &test_string) const override
virtual std::string	description (const OutputStyle style=Machine) const override
virtual std::unique_ptr< PatternBase >	clone () const override
std::size_t	memory_consumption () const override

Static Public Member Functions
static std::unique_ptr< Selection >	create (const std::string &description)

Private Attributes
std::string	sequence

Static Private Attributes
static const char *	description_init = "[Selection"

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 382 of file patterns.h.

Member Enumeration Documentation

OutputStyle

enum Patterns::PatternBase::OutputStyle

inherited

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.

Enumerator
Machine	Simple text suitable for machine parsing in the static public member functions for all of the built in inheriting classes. Preferably human readable, but machine parsing is more critical.
Text	Easily human readable plain text format suitable for plain text documentation.
LaTeX	Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 98 of file patterns.h.

Constructor & Destructor Documentation

Selection()

Patterns::Selection::Selection

(

const std::string &

seq

)

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

Definition at line 534 of file patterns.cc.

Member Function Documentation

match()

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

overridevirtual

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

Implements Patterns::PatternBase.

Definition at line 546 of file patterns.cc.

description()

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

overridevirtual

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 578 of file patterns.cc.

clone()

std::unique_ptr< PatternBase > Patterns::Selection::clone ( ) const

overridevirtual

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 613 of file patterns.cc.

memory_consumption()

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

overridevirtual

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

Reimplemented from Patterns::PatternBase.

Definition at line 620 of file patterns.cc.

create()

std::unique_ptr< Selection > Patterns::Selection::create ( const std::string &  description )

static

Create a 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 629 of file patterns.cc.

Member Data Documentation

sequence

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.

Definition at line 434 of file patterns.h.

description_init

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

staticprivate

Initial part of description

Definition at line 439 of file patterns.h.

---

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

• include/deal.II/base/patterns.h
• source/base/patterns.cc