dune-common
2.2.0
|
Parsers to set up a ParameterTree from various input sources
. More...
#include <dune/common/parametertreeparser.hh>
Static Public Member Functions | |
static void | readOptions (int argc, char *argv[], ParameterTree &pt) |
parse command line options and build hierarchical ParameterTree structure | |
Parsing methods for the INITree file format | |
INITree files should look like this # this file configures fruit colors in fruitsalad #these are no fruit but could also appear in fruit salad honeydewmelon = yellow watermelon = green fruit.tropicalfruit.orange = orange [fruit] strawberry = red pomegranate = red [fruit.pipfruit] apple = green/red/yellow pear = green [fruit.stonefruit] cherry = red plum = purple If a '[prefix]' statement appears all following entries use this prefix until the next '[prefix]' statement. Fruitsalads for example contain: honeydewmelon = yellow fruit.tropicalfruit.orange = orange fruit.pipfruit.apple = green/red/yellow fruit.stonefruit.cherry = red All keys with a common 'prefix.' belong to the same substructure called 'prefix'. Leading and trailing spaces and tabs are removed from the values unless you use single or double quotes around them. Using single or double quotes you can also have multiline values. | |
static void | readINITree (std::istream &in, ParameterTree &pt, bool overwrite) |
parse C++ stream | |
static void | readINITree (std::istream &in, ParameterTree &pt, const std::string srcname="stream", bool overwrite=true) |
parse C++ stream | |
static void | readINITree (std::string file, ParameterTree &pt, bool overwrite=true) |
parse file |
Parsers to set up a ParameterTree from various input sources
.
|
static |
parse C++ stream
Parses C++ stream and build hierarchical config structure.
in | The stream to parse |
pt | The parameter tree to store the config structure. |
overwrite | Whether to overwrite already existing values. If false, values in the stream will be ignored if the key is already present. |
|
static |
parse C++ stream
Parses C++ stream and build hierarchical config structure.
in | The stream to parse |
pt | The parameter tree to store the config structure. |
srcname | Name of the configuration source for error messages, "stdin" or a filename. |
overwrite | Whether to overwrite already existing values. If false, values in the stream will be ignored if the key is already present. |
References DUNE_THROW, and Dune::ParameterTree::hasKey().
|
static |
parse file
Parses file with given name and build hierarchical config structure.
file | filename |
pt | The parameter tree to store the config structure. |
overwrite | Whether to overwrite already existing values. If false, values in the stream will be ignored if the key is already present. |
References DUNE_THROW.
|
static |
parse command line options and build hierarchical ParameterTree structure
The list of command line options is searched for pairs of the type -key value
(note the hyphen in front of the key). For each such pair of options a key-value pair with the corresponding names is then created in the ParameterTree.
argc | arg count |
argv | arg values |
pt | The parameter tree to store the config structure. |