Patterns::Bool Class Reference

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

Inheritance diagram for Patterns::Bool:

Public Member Functions
	Bool ()
virtual std::string	description (const OutputStyle style=Machine) const
virtual PatternBase *	clone () const
Public Member Functions inherited from Patterns::Selection
	Selection (const std::string &seq)
virtual bool	match (const std::string &test_string) const
std::size_t	memory_consumption () const
Public Member Functions inherited from Patterns::PatternBase
virtual	~PatternBase ()

Static Public Member Functions
static Bool *	create (const std::string &description)
Static Public Member Functions inherited from Patterns::Selection
static Selection *	create (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 692 of file parameter_handler.h.

Constructor & Destructor Documentation

Bool()

Patterns::Bool::Bool

(

)

Constructor.

Definition at line 1114 of file parameter_handler.cc.

Member Function Documentation

description()

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

virtual

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

Reimplemented from Patterns::Selection.

Definition at line 1121 of file parameter_handler.cc.

clone()

PatternBase * Patterns::Bool::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.

Reimplemented from Patterns::Selection.

Definition at line 1150 of file parameter_handler.cc.

create()

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

Member Data Documentation

description_init

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

staticprivate

Initial part of description

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