Reference documentation for deal.II version 9.4.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
Patterns::MultipleSelection Class Reference

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

Inheritance diagram for Patterns::MultipleSelection:
[legend]

Public Types

enum  OutputStyle { Machine , Text , LaTeX }
 

Public Member Functions

 MultipleSelection (const std::string &seq)
 
virtual bool match (const std::string &test_string) const override
 
virtual std::string description (const OutputStyle style=Machine) const override
 
virtual std::unique_ptr< PatternBaseclone () const override
 
std::size_t memory_consumption () const override
 

Static Public Member Functions

static std::unique_ptr< MultipleSelectioncreate (const std::string &description)
 
static ::ExceptionBaseExcCommasNotAllowed (int arg1)
 

Private Attributes

std::string sequence
 

Static Private Attributes

static const char * description_init = "[MultipleSelection"
 

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

Member Enumeration Documentation

◆ OutputStyle

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.

Enumerator
Machine 

Simple text suitable for machine parsing in the static public member functions for all of the built in inheriting classes.

Preferably human readable, but machine parsing is more critical.

Text 

Easily human readable plain text format suitable for plain text documentation.

LaTeX 

Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 98 of file patterns.h.


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