![]() |
Reference documentation for deal.II version GIT d7aca55de5 2022-08-10 12:50:02+00:00
|
#include <deal.II/base/patterns.h>
Public Types | |
enum | OutputStyle { Machine , Text , LaTeX } |
Public Member Functions | |
Map (const PatternBase &key_pattern, const PatternBase &value_pattern, const unsigned int min_elements=0, const unsigned int max_elements=max_int_value, const std::string &separator=",", const std::string &key_value_separator=":") | |
Map (const Map &other) | |
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 |
const PatternBase & | get_key_pattern () const |
const PatternBase & | get_value_pattern () const |
const std::string & | get_separator () const |
const std::string & | get_key_value_separator () const |
Static Public Member Functions | |
static std::unique_ptr< Map > | create (const std::string &description) |
static ::ExceptionBase & | ExcInvalidRange (int arg1, int arg2) |
Static Public Attributes | |
static const unsigned int | max_int_value |
Private Attributes | |
std::unique_ptr< PatternBase > | key_pattern |
std::unique_ptr< PatternBase > | value_pattern |
const unsigned int | min_elements |
const unsigned int | max_elements |
const std::string | separator |
const std::string | key_value_separator |
Static Private Attributes | |
static const char * | description_init = "[Map" |
This pattern matches a list of comma-separated values each of which denotes a pair of key and value. Both key and value have to match a pattern given to the constructor. For each entry of the map, parameters have to be entered in the form key: value
. In other words, a map is described in the form key1: value1, key2: value2, key3: value3, ...
. Two constructor arguments allow to choose a delimiter between pairs other than the comma, and a delimiter between key and value other than colon.
With two additional parameters, the number of elements this list has to have can be specified. If none is specified, the map may have zero or more entries.
Definition at line 584 of file patterns.h.
|
inherited |
List of possible description output formats.
Capitalization chosen for similarity to ParameterHandler::OutputStyle.
Definition at line 98 of file patterns.h.
Patterns::Map::Map | ( | const PatternBase & | key_pattern, |
const PatternBase & | value_pattern, | ||
const unsigned int | min_elements = 0 , |
||
const unsigned int | max_elements = max_int_value , |
||
const std::string & | separator = "," , |
||
const std::string & | key_value_separator = ":" |
||
) |
Constructor. Take the given parameter as the specification of valid elements of the list.
The four other arguments can be used to denote minimal and maximal allowable lengths of the list as well as the separators used to delimit pairs of the map and the symbol used to separate keys and values.
Definition at line 825 of file patterns.cc.
Patterns::Map::Map | ( | const Map & | other | ) |
Copy constructor.
Definition at line 853 of file patterns.cc.
|
overridevirtual |
Return true
if the string is a comma-separated list of strings each of which match the pattern given to the constructor.
Implements Patterns::PatternBase.
Definition at line 865 of file patterns.cc.
|
overridevirtual |
Return a description of the pattern that valid strings are expected to match.
Implements Patterns::PatternBase.
Definition at line 895 of file patterns.cc.
|
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.
Definition at line 945 of file patterns.cc.
|
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 969 of file patterns.cc.
|
overridevirtual |
Determine an estimate for the memory consumption (in bytes) of this object.
Reimplemented from Patterns::PatternBase.
Definition at line 957 of file patterns.cc.
const PatternBase & Patterns::Map::get_key_pattern | ( | ) | const |
Return a reference to the key pattern.
Definition at line 1024 of file patterns.cc.
const PatternBase & Patterns::Map::get_value_pattern | ( | ) | const |
Return a reference to the value pattern.
Definition at line 1032 of file patterns.cc.
const std::string & Patterns::Map::get_separator | ( | ) | const |
Return the separator of the map entries.
Definition at line 1040 of file patterns.cc.
const std::string & Patterns::Map::get_key_value_separator | ( | ) | const |
Return the key-value separator.
Definition at line 1047 of file patterns.cc.
|
static |
Maximal integer value. If the numeric_limits class is available use this information to obtain the extremal values, otherwise set it so that this class understands that all values are allowed.
Definition at line 592 of file patterns.h.
|
private |
Copy of the patterns that each key and each value of the map has to satisfy.
Definition at line 694 of file patterns.h.
|
private |
Definition at line 695 of file patterns.h.
|
private |
Minimum number of elements the list must have.
Definition at line 700 of file patterns.h.
|
private |
Maximum number of elements the list must have.
Definition at line 705 of file patterns.h.
|
private |
Separator between elements of the list.
Definition at line 710 of file patterns.h.
|
private |
Separator between keys and values.
Definition at line 716 of file patterns.h.
|
staticprivate |
Initial part of description
Definition at line 721 of file patterns.h.