Reference documentation for deal.II version Git e512aac53a 2019-11-15 17:29:53 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Static Private Attributes | List of all members
Patterns::Bool Class Reference

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

Inheritance diagram for Patterns::Bool:
[legend]

Public Member Functions

 Bool ()
 
virtual std::string description (const OutputStyle style=Machine) const override
 
virtual std::unique_ptr< PatternBaseclone () const override
 
- Public Member Functions inherited from Patterns::Selection
 Selection (const std::string &seq)
 
virtual bool match (const std::string &test_string) const override
 
std::size_t memory_consumption () const override
 
- Public Member Functions inherited from Patterns::PatternBase
virtual ~PatternBase ()=default
 

Static Public Member Functions

static std::unique_ptr< Boolcreate (const std::string &description)
 
- Static Public Member Functions inherited from Patterns::Selection
static std::unique_ptr< Selectioncreate (const std::string &description)
 

Static Private Attributes

static const char * description_init = "[Bool"
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 984 of file patterns.h.

Constructor & Destructor Documentation

◆ Bool()

Patterns::Bool::Bool ( )

Constructor.

Definition at line 1388 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 1395 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 1423 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 1431 of file patterns.cc.

Member Data Documentation

◆ description_init

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

Initial part of description

Definition at line 1019 of file patterns.h.


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