Patterns::DirectoryName Class Reference

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

Inheritance diagram for Patterns::DirectoryName:

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

Static Public Member Functions
static 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 863 of file parameter_handler.h.

Constructor & Destructor Documentation

DirectoryName()

Patterns::DirectoryName::DirectoryName

(

)

Constructor.

Definition at line 1315 of file parameter_handler.cc.

Member Function Documentation

match()

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

virtual

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

Implements Patterns::PatternBase.

Definition at line 1320 of file parameter_handler.cc.

description()

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

virtual

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 1327 of file parameter_handler.cc.

clone()

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

Implements Patterns::PatternBase.

Definition at line 1355 of file parameter_handler.cc.

create()

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

Member Data Documentation

description_init

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

staticprivate

Initial part of description

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