shawn::SimulationEnvironment Class Reference

Access to configuration variables. More...

#include <simulation_environment.h>

Inheritance diagram for shawn::SimulationEnvironment:

[legend]

Collaboration diagram for shawn::SimulationEnvironment:

[legend]

List of all members.

Public Member Functions
	DECLARE_HANDLES (ParameterSet)
	SimulationEnvironment ()
	~SimulationEnvironment ()
void	push_parameters (const ParameterSetHandle &) throw ()
void	pop_parameters () throw ()
void	add_parameters_low_prio (const ParameterSetHandle &) throw ()
void	add_parameters_high_prio (const ParameterSetHandle &) throw ()
void	add_parameter_low_prio (const std::string &, const std::string &) throw ()
void	add_parameter_high_prio (const std::string &, const std::string &) throw ()
const std::string &	required_string_param (const std::string &) const throw ( std::runtime_error )
const std::string &	optional_string_param (const std::string &, const std::string &, bool *is_set=NULL) const throw ( std::runtime_error )
int	required_int_param (const std::string &) const throw ( std::runtime_error )
int	optional_int_param (const std::string &, int, bool *is_set=NULL) const throw ( std::runtime_error )
double	required_double_param (const std::string &) const throw ( std::runtime_error )
double	optional_double_param (const std::string &, double, bool *is_set=NULL) const throw ( std::runtime_error )
bool	required_bool_param (const std::string &) const throw ( std::runtime_error )
bool	optional_bool_param (const std::string &, bool, bool *is_set=NULL) const throw ( std::runtime_error )
bool	find_param (const std::string &, const std::string *&) const throw ()
Protected Member Functions
int	string2int (const std::string &key, const std::string &value) const throw ( std::runtime_error )
double	string2double (const std::string &key, const std::string &value) const throw ( std::runtime_error )
bool	string2bool (const std::string &key, const std::string &value) const throw ( std::runtime_error )
Classes
class	ParameterSet

---

Detailed Description

Access to configuration variables.

Todo:

use string_utils!

---

Constructor & Destructor Documentation

shawn::SimulationEnvironment::SimulationEnvironment

(

)

shawn::SimulationEnvironment::~SimulationEnvironment

(

)

---

Member Function Documentation

shawn::SimulationEnvironment::DECLARE_HANDLES

(

ParameterSet

)

void shawn::SimulationEnvironment::push_parameters

(

const ParameterSetHandle &

)

throw ()

void shawn::SimulationEnvironment::pop_parameters

(

)

throw ()

void shawn::SimulationEnvironment::add_parameters_low_prio

(

const ParameterSetHandle &

)

throw ()

void shawn::SimulationEnvironment::add_parameters_high_prio

(

const ParameterSetHandle &

)

throw ()

void shawn::SimulationEnvironment::add_parameter_low_prio	(	const std::string &	,
		const std::string &
	)			throw ()

void shawn::SimulationEnvironment::add_parameter_high_prio	(	const std::string &	,
		const std::string &
	)			throw ()

const std::string& shawn::SimulationEnvironment::required_string_param

(

const std::string &

)

const throw ( std::runtime_error )

const std::string& shawn::SimulationEnvironment::optional_string_param	(	const std::string &	,
		const std::string &	,
		bool *	is_set = NULL
	)			const throw ( std::runtime_error )

int shawn::SimulationEnvironment::required_int_param

(

const std::string &

)

const throw ( std::runtime_error )

int shawn::SimulationEnvironment::optional_int_param	(	const std::string &	,
		int	,
		bool *	is_set = NULL
	)			const throw ( std::runtime_error )

double shawn::SimulationEnvironment::required_double_param

(

const std::string &

)

const throw ( std::runtime_error )

double shawn::SimulationEnvironment::optional_double_param	(	const std::string &	,
		double	,
		bool *	is_set = NULL
	)			const throw ( std::runtime_error )

bool shawn::SimulationEnvironment::required_bool_param

(

const std::string &

)

const throw ( std::runtime_error )

bool shawn::SimulationEnvironment::optional_bool_param	(	const std::string &	,
		bool	,
		bool *	is_set = NULL
	)			const throw ( std::runtime_error )

bool shawn::SimulationEnvironment::find_param	(	const std::string &	,
		const std::string *&
	)			const throw ()

int shawn::SimulationEnvironment::string2int	(	const std::string &	key,
		const std::string &	value
	)			const throw ( std::runtime_error ) [protected]

double shawn::SimulationEnvironment::string2double	(	const std::string &	key,
		const std::string &	value
	)			const throw ( std::runtime_error ) [protected]

bool shawn::SimulationEnvironment::string2bool	(	const std::string &	key,
		const std::string &	value
	)			const throw ( std::runtime_error ) [protected]

---

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

• src/sys/simulation/simulation_environment.h