Reference documentation for deal.II version Git 34859fde61 2019-12-10 11:26:22 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Static Private Attributes | List of all members
Patterns::DirectoryName Class Reference

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

Inheritance diagram for Patterns::DirectoryName:
[legend]

Public Member Functions

 DirectoryName ()=default
 
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
 
- Public Member Functions inherited from Patterns::PatternBase
virtual ~PatternBase ()=default
 
virtual std::size_t memory_consumption () const
 

Static Public Member Functions

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

Static Private Attributes

static const char * description_init = "[DirectoryName"
 

Additional Inherited Members

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

Detailed Description

A pattern that can be used to indicate when a parameter is intended to be the name of a directory. By itself, this class does not check whether the string that is given in a parameter file actually corresponds to an existing directory. Functionally, the class is therefore equivalent to the Anything class. However, it allows to specify the intent of a parameter.

The reason for the existence of this class is to support graphical user interfaces for editing parameter files. These may open a file selection dialog to select or create a directory.

Definition at line 1166 of file patterns.h.

Constructor & Destructor Documentation

◆ DirectoryName()

Patterns::DirectoryName::DirectoryName ( )
default

Constructor.

Member Function Documentation

◆ match()

bool Patterns::DirectoryName::match ( const std::string &  test_string) const
overridevirtual

Return true if the string matches its constraints, i.e. always.

Implements Patterns::PatternBase.

Definition at line 1598 of file patterns.cc.

◆ description()

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

Return a description of the pattern that valid strings are expected to match. Here, this is the string "[Filename]".

Implements Patterns::PatternBase.

Definition at line 1606 of file patterns.cc.

◆ clone()

std::unique_ptr< PatternBase > Patterns::DirectoryName::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.

Implements Patterns::PatternBase.

Definition at line 1634 of file patterns.cc.

◆ create()

std::unique_ptr< DirectoryName > Patterns::DirectoryName::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 1642 of file patterns.cc.

Member Data Documentation

◆ description_init

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

Initial part of description

Definition at line 1208 of file patterns.h.


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