Patterns::DirectoryName Class Reference

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

Inheritance diagram for Patterns::DirectoryName:

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< PatternBase >	clone () 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< DirectoryName >	create (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.

---

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

• include/deal.II/base/patterns.h
• source/base/patterns.cc