Reference documentation for deal.II version Git 2a81969 2017-11-21 09:22:35 +0100
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | Static Private Attributes | List of all members
Patterns::List Class Reference

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

Inheritance diagram for Patterns::List:
[legend]

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=",")
 
const std::string & get_separator () const
 
const PatternBaseget_base_pattern () const
 
 List (const List &other)
 
virtual bool match (const std::string &test_string) const
 
virtual std::string description (const OutputStyle style=Machine) const
 
virtual std::unique_ptr< PatternBaseclone () const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Patterns::PatternBase
virtual ~PatternBase ()=default
 

Static Public Member Functions

static std::unique_ptr< Listcreate (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

std::unique_ptr< PatternBasepattern
 
const unsigned int min_elements
 
const unsigned int max_elements
 
const std::string separator
 

Static Private Attributes

static const char * description_init = "[List"
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

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.

Definition at line 632 of file patterns.cc.

Patterns::List::List ( const List other)

Copy constructor.

Definition at line 650 of file patterns.cc.

Member Function Documentation

const std::string & Patterns::List::get_separator ( ) const

Return the internally stored separator.

Definition at line 659 of file patterns.cc.

const PatternBase & Patterns::List::get_base_pattern ( ) const

Return the internally stored base pattern.

Definition at line 666 of file patterns.cc.

bool Patterns::List::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 673 of file patterns.cc.

std::string Patterns::List::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 692 of file patterns.cc.

std::unique_ptr< PatternBase > Patterns::List::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 738 of file patterns.cc.

std::unique_ptr< List > Patterns::List::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 754 of file patterns.cc.

std::size_t Patterns::List::memory_consumption ( ) const
virtual

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

Reimplemented from Patterns::PatternBase.

Definition at line 745 of file patterns.cc.

Member Data Documentation

const unsigned int Patterns::List::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 429 of file patterns.h.

std::unique_ptr<PatternBase> Patterns::List::pattern
private

Copy of the pattern that each element of the list has to satisfy.

Definition at line 509 of file patterns.h.

const unsigned int Patterns::List::min_elements
private

Minimum number of elements the list must have.

Definition at line 514 of file patterns.h.

const unsigned int Patterns::List::max_elements
private

Maximum number of elements the list must have.

Definition at line 519 of file patterns.h.

const std::string Patterns::List::separator
private

Separator between elements of the list.

Definition at line 524 of file patterns.h.

const char * Patterns::List::description_init = "[List"
staticprivate

Initial part of description

Definition at line 529 of file patterns.h.


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