Reference documentation for deal.II version GIT 7bd1c95dbb 2022-06-29 20:50:01+00:00
Patterns::FileName Class Reference

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

Inheritance diagram for Patterns::FileName:
[legend]

## Public Types

enum  FileType { input = 0 , output = 1 }

enum  OutputStyle { Machine , Text , LaTeX }

## Public Member Functions

FileName (const FileType type=input)

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

virtual std::size_t memory_consumption () const

## Static Public Member Functions

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

## Public Attributes

FileType file_type

## Static Private Attributes

static const char * description_init = "[FileName"

## Detailed Description

A pattern that can be used to indicate when a parameter is intended to be the name of a file. By itself, this class does not check whether the string that is given in a parameter file actually corresponds to an existing file (it could, for example, be the name of a file to which you want to write output). Functionally, the class is therefore equivalent to the Anything class. However, it allows to specify the intent of a parameter. The flag given to the constructor also allows to specify whether the file is supposed to be an input or output file.

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 if the filename is supposed to represent an input file.

Definition at line 1083 of file patterns.h.

## ◆ OutputStyle

 inherited

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.

Enumerator
Machine

Simple text suitable for machine parsing in the static public member functions for all of the built in inheriting classes.

Preferably human readable, but machine parsing is more critical.

Text

Easily human readable plain text format suitable for plain text documentation.

LaTeX

Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 98 of file patterns.h.

## ◆ memory_consumption()

 std::size_t Patterns::PatternBase::memory_consumption ( ) const
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::MultipleSelection, Patterns::Tuple, Patterns::Map, Patterns::List, and Patterns::Selection.

Definition at line 192 of file patterns.cc.

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