Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Attributes

Patterns::FileName Class Reference

Inheritance diagram for Patterns::FileName:
Inheritance graph
[legend]

List of all members.

Public Types

enum  FileType

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

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


Member Enumeration Documentation

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

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

file type flag

Definition at line 951 of file parameter_handler.h.

const char* Patterns::FileName::description_init [static, private]

Initial part of description

Definition at line 966 of file parameter_handler.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Mon May 21 2012 12:06:35 by doxygen 1.7.3