Patterns::FileName Class Reference

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

Inheritance diagram for Patterns::FileName:

Public Types
enum	FileType { input = 0, output = 1 }
Public Types inherited from Patterns::PatternBase
enum	OutputStyle { Machine, Text, LaTeX }

Public Member Functions
	FileName (const FileType type=input)
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 FileName *	create (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 787 of file parameter_handler.h.

Member Enumeration Documentation

FileType

enum Patterns::FileName::FileType

Files can be used for input or output. This can be specified in the constructor by choosing the flag type.

Enumerator
input	Open for input.
output	Open for output.

Definition at line 794 of file parameter_handler.h.

Constructor & Destructor Documentation

FileName()

Patterns::FileName::FileName

(

const FileType

type = input

)

Constructor. The type of the file can be specified by choosing the flag.

Definition at line 1231 of file parameter_handler.cc.

Member Function Documentation

match()

bool Patterns::FileName::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 1237 of file parameter_handler.cc.

description()

std::string Patterns::FileName::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 1244 of file parameter_handler.cc.

clone()

PatternBase * Patterns::FileName::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 1280 of file parameter_handler.cc.

create()

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

Member Data Documentation

file_type

FileType Patterns::FileName::file_type

file type flag

Definition at line 834 of file parameter_handler.h.

description_init

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

staticprivate

Initial part of description

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