Patterns::Map Class Reference

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

Inheritance diagram for Patterns::Map:

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=",")
virtual	~Map ()
virtual bool	match (const std::string &test_string) const
virtual std::string	description (const OutputStyle style=Machine) const
virtual PatternBase *	clone () const
std::size_t	memory_consumption () const
Public Member Functions inherited from Patterns::PatternBase
virtual	~PatternBase ()

Static Public Member Functions
static Map *	create (const std::string &description)
static ::ExceptionBase &	ExcInvalidRange (int arg1, int arg2)

Static Public Attributes
static const unsigned int	max_int_value = std::numeric_limits<unsigned int>::max()

Private Attributes
PatternBase *	key_pattern
const unsigned int	min_elements
const unsigned int	max_elements
const std::string	separator

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

Additional Inherited Members
Public Types inherited from Patterns::PatternBase
enum	OutputStyle { Machine, Text, LaTeX }

Detailed Description

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, .... A constructor argument allows to choose a delimiter between pairs other than the comma.

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

Constructor & Destructor Documentation

Map()

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 = ","
	)

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 as well as the separator used to delimit pairs of the map.

Definition at line 747 of file parameter_handler.cc.

~Map()

Patterns::Map::~Map ( )

virtual

Destructor.

Definition at line 770 of file parameter_handler.cc.

Member Function Documentation

match()

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

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.

Definition at line 781 of file parameter_handler.cc.

description()

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

virtual

Return a description of the pattern that valid strings are expected to match.

Implements Patterns::PatternBase.

Definition at line 847 of file parameter_handler.cc.

clone()

PatternBase * Patterns::Map::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.

Definition at line 897 of file parameter_handler.cc.

create()

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

static

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 916 of file parameter_handler.cc.

memory_consumption()

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

virtual

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

Reimplemented from Patterns::PatternBase.

Definition at line 906 of file parameter_handler.cc.

Member Data Documentation

max_int_value

const unsigned int Patterns::Map::max_int_value = std::numeric_limits<unsigned int>::max()

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

key_pattern

PatternBase* Patterns::Map::key_pattern

private

Copy of the patterns that each key and each value of the map has to satisfy.

Definition at line 586 of file parameter_handler.h.

min_elements

const unsigned int Patterns::Map::min_elements

private

Minimum number of elements the list must have.

Definition at line 592 of file parameter_handler.h.

max_elements

const unsigned int Patterns::Map::max_elements

private

Maximum number of elements the list must have.

Definition at line 597 of file parameter_handler.h.

separator

const std::string Patterns::Map::separator

private

Separator between elements of the list.

Definition at line 602 of file parameter_handler.h.

description_init

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

staticprivate

Initial part of description

Definition at line 607 of file parameter_handler.h.

---

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

• deal.II/base/parameter_handler.h
• source/base/parameter_handler.cc