![]() |
Reference documentation for deal.II version 8.1.0
|
#include <parameter_handler.h>
Public Member Functions | |
List (const PatternBase &base_pattern, const unsigned int min_elements=0, const unsigned int max_elements=max_int_value, const std::string &separator=",") | |
virtual | ~List () |
virtual bool | match (const std::string &test_string) const |
virtual std::string | description () const |
virtual PatternBase * | clone () const |
std::size_t | memory_consumption () const |
DeclException2 (ExcInvalidRange, int, int,<< "The values "<< arg1<< " and "<< arg2<< " do not form a valid range.") | |
![]() | |
virtual | ~PatternBase () |
Static Public Member Functions | |
static List * | create (const std::string &description) |
Static Public Attributes | |
static const unsigned int | max_int_value |
Private Attributes | |
PatternBase * | pattern |
const unsigned int | min_elements |
const unsigned int | max_elements |
const std::string | separator |
Static Private Attributes | |
static const char * | description_init |
This pattern matches a list of values separated by commas (or another string), each of which have to match a pattern given to the constructor. With two additional parameters, the number of elements this list has to have can be specified. If none is specified, the list may have zero or more entries.
Definition at line 378 of file parameter_handler.h.
Patterns::List::List | ( | const PatternBase & | base_pattern, |
const unsigned int | min_elements = 0 , |
||
const unsigned int | max_elements = max_int_value , |
||
const std::string & | separator = "," |
||
) |
Constructor. Take the given parameter as the specification of valid elements of the list.
The three other arguments can be used to denote minimal and maximal allowable lengths of the list, and the string that is used as a separator between elements of the list.
|
virtual |
Destructor.
|
virtual |
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.
|
virtual |
Return a description of the pattern that valid strings are expected to match.
Implements Patterns::PatternBase.
|
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 |
Creates new object if the start of description matches description_init. Ownership of that object is transferred to the caller of this function.
|
virtual |
Determine an estimate for the memory consumption (in bytes) of this object.
Reimplemented from Patterns::PatternBase.
|
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 386 of file parameter_handler.h.
|
private |
Copy of the pattern that each element of the list has to satisfy.
Definition at line 454 of file parameter_handler.h.
|
private |
Minimum number of elements the list must have.
Definition at line 459 of file parameter_handler.h.
|
private |
Maximum number of elements the list must have.
Definition at line 464 of file parameter_handler.h.
|
private |
Separator between elements of the list.
Definition at line 469 of file parameter_handler.h.
|
staticprivate |
Initial part of description
Definition at line 474 of file parameter_handler.h.