deal.II version GIT relicensing-1991-gec5bc16adb 2024-10-14 08:00:00+00:00
|
#include <deal.II/base/patterns.h>
Public Types | |
enum | OutputStyle { Machine , Text , LaTeX } |
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 |
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" |
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 1165 of file patterns.h.
|
inherited |
List of possible description output formats.
Capitalization chosen for similarity to ParameterHandler::OutputStyle.
Definition at line 100 of file patterns.h.
|
default |
Constructor.
|
overridevirtual |
Return true
if the string matches its constraints, i.e. always.
Implements Patterns::PatternBase.
Definition at line 1616 of file patterns.cc.
|
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 1624 of file patterns.cc.
|
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 1652 of file patterns.cc.
|
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 1660 of file patterns.cc.
|
virtualinherited |
Determine an estimate for the memory consumption (in bytes) of this object. To avoid unnecessary overhead, we do not force derived classes to provide this function as a virtual overloaded one, but rather try to cast the present object to one of the known derived classes and if that fails then take the size of this base class instead and add 32 byte (this value is arbitrary, it should account for virtual function tables, and some possible data elements). Since there are usually not many thousands of objects of this type around, and since the memory_consumption mechanism is used to find out where memory in the range of many megabytes is, this seems like a reasonable approximation.
On the other hand, if you know that your class deviates from this assumption significantly, you can still overload this function.
Reimplemented in Patterns::Selection, Patterns::List, Patterns::Map, Patterns::Tuple, and Patterns::MultipleSelection.
Definition at line 189 of file patterns.cc.
|
staticprivate |
Initial part of description
Definition at line 1207 of file patterns.h.