Patterns::MultipleSelection Class Reference

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

Inheritance diagram for Patterns::MultipleSelection:

Public Member Functions
	MultipleSelection (const std::string &seq)
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 MultipleSelection *	create (const std::string &description)
static ::ExceptionBase &	ExcCommasNotAllowed (int arg1)

Private Attributes
std::string	sequence

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

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

Detailed Description

This class is much like the Selection class, but it allows the input to be a comma-separated list of values which each have to be given in the constructor argument. The input is allowed to be empty or contain values more than once and have an arbitrary number of spaces around commas. Of course commas are not allowed inside the values given to the constructor.

For example, if the string to the constructor was "ucd|gmv|eps", then the following would be legal inputs: "eps", "gmv, eps", or "".

Definition at line 621 of file parameter_handler.h.

Constructor & Destructor Documentation

MultipleSelection()

Patterns::MultipleSelection::MultipleSelection

(

const std::string &

seq

)

Constructor. seq is a list of valid options separated by "|".

Definition at line 966 of file parameter_handler.cc.

Member Function Documentation

match()

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

virtual

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

Implements Patterns::PatternBase.

Definition at line 979 of file parameter_handler.cc.

description()

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

virtual

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.

Definition at line 1043 of file parameter_handler.cc.

clone()

PatternBase * Patterns::MultipleSelection::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 1079 of file parameter_handler.cc.

create()

MultipleSelection * Patterns::MultipleSelection::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 1094 of file parameter_handler.cc.

memory_consumption()

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

virtual

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

Reimplemented from Patterns::PatternBase.

Definition at line 1086 of file parameter_handler.cc.

Member Data Documentation

sequence

std::string Patterns::MultipleSelection::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 680 of file parameter_handler.h.

description_init

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

staticprivate

Initial part of description

Definition at line 685 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