ConfigWriter Class Reference

Toolbox to dump user-steered configuration into Python scripts. More...

#include <CepGenAddOns/PythonWrapper/ConfigWriter.h>

Inheritance diagram for ConfigWriter:

Collaboration diagram for ConfigWriter:

Public Member Functions
	ConfigWriter (const ParametersList &)
	~ConfigWriter ()
ConfigWriter &	operator<< (const RunParameters &)
	Feed a full run parameters block.
ConfigWriter &	operator<< (const ParametersDescription &)
	Feed a single parameters description object.
std::string	operator() () const
	Retrieve the configuration as a string.
bool	operator== (const SteeredObject &oth) const
	Equality operator.
bool	operator!= (const SteeredObject &oth) const
	Inequality operator.
const ParametersList &	parameters () const override
	Module user-defined parameters.
virtual void	setParameters (const ParametersList &params) override
	Set module parameters.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()

Protected Member Functions
template<typename T >
T	steer (const std::string &key) const
	Retrieve a parameters as previously steered.
template<typename T , typename U >
U	steerAs (const std::string &key) const
	Retrieve a recasted parameters as previously steered.
std::string	steerName () const
	Retrieve module name from parameters.
std::string	steerPath (const std::string &key) const
	Retrieve a path from common search paths.

Protected Attributes
ParametersList	params_
	Module parameters.

Detailed Description

Definition at line 29 of file ConfigWriter.h.

Constructor & Destructor Documentation

ConfigWriter()

ConfigWriter

(

const ParametersList &

params

)

Definition at line 81 of file ConfigWriter.cpp.

~ConfigWriter()

~ConfigWriter

(

)

Definition at line 89 of file ConfigWriter.cpp.

Member Function Documentation

description()

ParametersDescription description ( )

static

Definition at line 180 of file ConfigWriter.cpp.

operator!=()

bool operator!= ( const SteeredObject< ConfigWriter > &  oth ) const

inherited

Definition at line 51 of file SteeredObject.h.

operator()()

std::string operator()

(

)

const

Definition at line 178 of file ConfigWriter.cpp.

operator<<() [1/2]

ConfigWriter & operator<<

(

const ParametersDescription &

pdesc

)

Definition at line 108 of file ConfigWriter.cpp.

operator<<() [2/2]

ConfigWriter & operator<<

(

const RunParameters &

params

)

Definition at line 96 of file ConfigWriter.cpp.

operator==()

bool operator== ( const SteeredObject< ConfigWriter > &  oth ) const

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 of file SteeredObject.h.

steer()

template<typename T >

T steer ( const std::string &  key ) const

protectedinherited

Definition at line 39 of file Steerable.h.

steerAs()

template<typename T , typename U >

U steerAs ( const std::string &  key ) const

protectedinherited

Definition at line 44 of file Steerable.h.

steerName()

std::string steerName ( ) const

protectedinherited

Definition at line 48 of file Steerable.h.

steerPath()

std::string steerPath ( const std::string &  key ) const

protectedinherited

Definition at line 30 of file Steerable.cpp.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.