Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Attributes | List of all members
Patterns::FileName Class Reference

#include <parameter_handler.h>

Inheritance diagram for Patterns::FileName:
[legend]

Public Types

enum  FileType { input = 0, output = 1 }
 

Public Member Functions

 FileName (const FileType type=input)
 
virtual bool match (const std::string &test_string) const
 
virtual std::string description () const
 
virtual PatternBaseclone () const
 
- Public Member Functions inherited from Patterns::PatternBase
virtual ~PatternBase ()
 
virtual std::size_t memory_consumption () const
 

Static Public Member Functions

static FileNamecreate (const std::string &description)
 

Public Attributes

FileType file_type
 

Static Private Attributes

static const char * description_init
 

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 771 of file parameter_handler.h.

Constructor & Destructor Documentation

Patterns::FileName::FileName ( const FileType  type = input)

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

Member Function Documentation

virtual 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.

virtual std::string Patterns::FileName::description ( ) const
virtual

Return a description of the pattern that valid strings are expected to match. Here, this is the string "[Filename]".

Implements Patterns::PatternBase.

virtual 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.

static 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.

Member Data Documentation

FileType Patterns::FileName::file_type

file type flag

Definition at line 808 of file parameter_handler.h.

const char* Patterns::FileName::description_init
staticprivate

Initial part of description

Definition at line 821 of file parameter_handler.h.


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