Hierarchical structure of string parameters. More...

#include <dune/common/parametertree.hh>

Classes
struct	Parser< array< T, n > >

struct	Parser< bool >

struct	Parser< FieldVector< T, n > >

struct	Parser< std::basic_string< char, traits, Allocator > >

struct	Parser< std::vector< T, A > >

Public Types
typedef std::vector< std::string >	KeyVector
	storage for key lists More...

Public Member Functions
	ParameterTree ()
	Create new empty ParameterTree. More...

bool	hasKey (const std::string &key) const
	test for key More...

bool	hasSub (const std::string &sub) const
	test for substructure More...

std::string &	operator[] (const std::string &key)
	get value reference for key More...

const std::string &	operator[] (const std::string &key) const
	get value reference for key More...

void	report (std::ostream &stream=std::cout, const std::string &prefix="") const
	print distinct substructure to stream More...

ParameterTree &	sub (const std::string &sub)
	get substructure by name More...

const ParameterTree &	sub (const std::string &sub) const
	get const substructure by name More...

std::string	get (const std::string &key, const std::string &defaultValue) const
	get value as string More...

std::string	get (const std::string &key, const char *defaultValue) const
	get value as string More...

int	get (const std::string &key, int defaultValue) const
	get value as int More...

double	get (const std::string &key, double defaultValue) const
	get value as double More...

template<typename T >
T	get (const std::string &key, const T &defaultValue) const
	get value converted to a certain type More...

template<class T >
T	get (const std::string &key) const
	Get value. More...

const KeyVector &	getValueKeys () const
	get value keys More...

const KeyVector &	getSubKeys () const
	get substructure keys More...

Static Protected Member Functions
static std::string	ltrim (const std::string &s)

static std::string	rtrim (const std::string &s)

static std::vector< std::string >	split (const std::string &s)

template<class Iterator >
static void	parseRange (const std::string &str, Iterator it, const Iterator &end)

Protected Attributes
KeyVector	valueKeys

KeyVector	subKeys

std::map< std::string, std::string >	values

std::map< std::string, ParameterTree >	subs

Detailed Description

Hierarchical structure of string parameters.

Member Typedef Documentation

typedef std::vector<std::string> Dune::ParameterTree::KeyVector

storage for key lists

Constructor & Destructor Documentation

ParameterTree::ParameterTree ( )

Create new empty ParameterTree.

Member Function Documentation

std::string ParameterTree::get	(	const std::string &	key,
		const std::string &	defaultValue
	)		const

get value as string

Returns pure string value for given key.

Parameters

key	key name
defaultValue	default if key does not exist

Returns: value as string

References hasKey().

std::string ParameterTree::get	(	const std::string &	key,
		const char *	defaultValue
	)		const

get value as string

Returns pure string value for given key.

Todo:

This is a hack so get("my_key", "xyz") compiles (without this method "xyz" resolves to bool instead of std::string)

Parameters

key	key name
defaultValue	default if key does not exist

Returns: value as string

References hasKey().

int ParameterTree::get	(	const std::string &	key,
		int	defaultValue
	)		const

get value as int

Returns value for given key interpreted as int.

Parameters

key	key name
defaultValue	default if key does not exist

Returns: value as int

double ParameterTree::get	(	const std::string &	key,
		double	defaultValue
	)		const

get value as double

Returns value for given key interpreted as double.

Parameters

key	key name
defaultValue	default if key does not exist

Returns: value as double

References hasKey().

template<typename T >

T Dune::ParameterTree::get	(	const std::string &	key,
		const T &	defaultValue
	)		const

inline

get value converted to a certain type

Returns value as type T for given key.

Template Parameters

T	type of returned value.

Parameters

key	key name
defaultValue	default if key does not exist

Returns: value converted to T

References hasKey().

template<class T >

T Dune::ParameterTree::get ( const std::string & key ) const

inline

Get value.

Template Parameters

T	Type of the value

Parameters

key Key name

Exceptions

RangeError	if key does not exist
NotImplemented	Type is not supported

Returns: value as T

References DUNE_THROW, and hasKey().

const ParameterTree::KeyVector & ParameterTree::getSubKeys ( ) const

get substructure keys

Returns a vector of all keys associated to (key,substructure) entries in order of appearance

Returns: reference to entry vector

References subKeys.

const ParameterTree::KeyVector & ParameterTree::getValueKeys ( ) const

get value keys

Returns a vector of all keys associated to (key,values) entries in order of appearance

Returns: reference to entry vector

References valueKeys.

bool ParameterTree::hasKey ( const std::string & key ) const

test for key

Tests whether given key exists.

Parameters

key key name

Returns: true if key exists in structure, otherwise false

References Dune::dot(), hasKey(), sub(), subs, and values.

Referenced by get(), hasKey(), operator[](), and Dune::ParameterTreeParser::readINITree().

bool ParameterTree::hasSub ( const std::string & sub ) const

test for substructure

Tests whether given substructure exists.

Parameters

sub	substructure name

Returns: true if substructure exists in structure, otherwise false

References Dune::dot(), hasSub(), sub(), and subs.

Referenced by hasSub(), and operator[]().

std::string ParameterTree::ltrim ( const std::string & s )

staticprotected

Referenced by Dune::ParameterTree::Parser< std::basic_string< char, traits, Allocator > >::parse().

std::string & ParameterTree::operator[] ( const std::string & key )

get value reference for key

Returns reference to value for given key name. This creates the key, if not existent.

Parameters

key key name

Returns: reference to corresponding value

References Dune::dot(), hasKey(), hasSub(), sub(), subKeys, subs, valueKeys, and values.

const std::string & ParameterTree::operator[] ( const std::string & key ) const

get value reference for key

Returns reference to value for given key name. This creates the key, if not existent.

Parameters

key key name

Returns: reference to corresponding value

Exceptions

Dune::RangeError if key is not found

References Dune::dot(), DUNE_THROW, hasKey(), hasSub(), sub(), and values.

template<class Iterator >

static void Dune::ParameterTree::parseRange	(	const std::string &	str,
		Iterator	it,
		const Iterator &	end
	)

inlinestaticprotected

References DUNE_THROW.

Referenced by Dune::ParameterTree::Parser< FieldVector< T, n > >::parse(), and Dune::ParameterTree::Parser< array< T, n > >::parse().

void ParameterTree::report	(	std::ostream &	stream = `std::cout`,
		const std::string &	prefix = `""`
	)		const

print distinct substructure to stream

Prints all entries with given prefix.

Parameters

stream	Stream to print to
prefix	for key and substructure names

References subs, and values.

std::string ParameterTree::rtrim ( const std::string & s )

staticprotected

Referenced by Dune::ParameterTree::Parser< std::basic_string< char, traits, Allocator > >::parse().

std::vector< std::string > ParameterTree::split ( const std::string & s )

staticprotected

Referenced by Dune::ParameterTree::Parser< std::vector< T, A > >::parse().

ParameterTree & ParameterTree::sub ( const std::string & sub )

get substructure by name

Parameters

sub	substructure name

Returns: reference to substructure

References Dune::dot(), sub(), subKeys, and subs.

Referenced by hasKey(), hasSub(), operator[](), Dune::ParameterTree::Parser< std::vector< T, A > >::parse(), and sub().

const ParameterTree & ParameterTree::sub ( const std::string & sub ) const

get const substructure by name

Parameters

sub	substructure name

Returns: reference to substructure

References Dune::dot(), DUNE_THROW, sub(), and subs.

Member Data Documentation

KeyVector Dune::ParameterTree::subKeys

protected

Referenced by getSubKeys(), operator[](), and sub().

std::map<std::string, ParameterTree> Dune::ParameterTree::subs

protected

Referenced by hasKey(), hasSub(), operator[](), report(), and sub().

KeyVector Dune::ParameterTree::valueKeys

protected

Referenced by getValueKeys(), and operator[]().

std::map<std::string, std::string> Dune::ParameterTree::values

protected

Referenced by hasKey(), operator[](), and report().

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

Classes

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation