
Public Member Functions | |
| DirectoryName () | |
| virtual bool | match (const std::string &test_string) const |
| virtual std::string | description () const |
| virtual PatternBase * | clone () const |
Static Public Member Functions | |
| static DirectoryName * | create (const std::string &description) |
Static Private Attributes | |
| static const char * | description_init |
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 988 of file parameter_handler.h.
| Patterns::DirectoryName::DirectoryName | ( | ) |
Constructor.
| virtual 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.
| virtual std::string Patterns::DirectoryName::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::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.
| static 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.
const char* Patterns::DirectoryName::description_init [static, private] |
Initial part of description
Definition at line 1036 of file parameter_handler.h.
documentation generated on Mon May 21 2012 12:06:35 by
doxygen
1.7.3