Reference documentation for deal.II version GIT eef19498cf 2022-10-05 14:45:02+00:00
\(\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::Bool Class Reference

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

Inheritance diagram for Patterns::Bool:
[legend]

Public Types

enum  OutputStyle { Machine , Text , LaTeX }
 

Public Member Functions

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

Static Public Member Functions

static std::unique_ptr< Boolcreate (const std::string &description)
 

Private Attributes

std::string sequence
 

Static Private Attributes

static const char * description_init = "[Bool"
 

Detailed Description

Test for the string being either "true" or "false". This is mapped to the Selection class.

Definition at line 982 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 99 of file patterns.h.

Constructor & Destructor Documentation

◆ Bool()

Patterns::Bool::Bool ( )

Constructor.

Definition at line 1392 of file patterns.cc.

Member Function Documentation

◆ description()

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

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

Reimplemented from Patterns::Selection.

Definition at line 1399 of file patterns.cc.

◆ clone()

std::unique_ptr< PatternBase > Patterns::Bool::clone ( ) const
overridevirtual

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.

Reimplemented from Patterns::Selection.

Definition at line 1427 of file patterns.cc.

◆ create()

std::unique_ptr< Bool > Patterns::Bool::create ( const std::string &  description)
static

Create a 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 1435 of file patterns.cc.

◆ match()

bool Patterns::Selection::match ( const std::string &  test_string) const
overridevirtualinherited

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

Implements Patterns::PatternBase.

Definition at line 546 of file patterns.cc.

◆ memory_consumption()

std::size_t Patterns::Selection::memory_consumption ( ) const
overridevirtualinherited

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

Reimplemented from Patterns::PatternBase.

Definition at line 620 of file patterns.cc.

Member Data Documentation

◆ description_init

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

Initial part of description

Definition at line 1017 of file patterns.h.

◆ sequence

std::string Patterns::Selection::sequence
privateinherited

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


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