Handler Class Reference

Base steering card module. More...

#include <CepGen/Cards/Handler.h>

Inheritance diagram for Handler:

Collaboration diagram for Handler:

Public Member Functions
	Handler (const ParametersList &)
	Build a configuration from an external steering card.
virtual	~Handler ()=default
virtual Handler &	parseCommands (const std::vector< std::string > &)
	Read configuration from command strings.
virtual Handler &	parseFile (const std::string &)
	Read configuration from steering card.
virtual void	write (const std::string &) const
	Write steering card from configuration.
virtual Handler &	setRunParameters (const RunParameters *)
	Specify runtime parameters.
const RunParameters *	runParameters () const
	Parsed runtime parameters.
std::unique_ptr< RunParameters > &	runParameters ()
	Parsed runtime parameters.
const std::string &	name () const
	Module unique indexing name.
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
const std::string	filename_
	Input filename.
const std::string	name_
	Module unique indexing name.
ParametersList	params_
	Module parameters.

Detailed Description

Definition at line 31 of file Handler.h.

Constructor & Destructor Documentation

Handler()

Handler ( const ParametersList &  params )

explicit

Definition at line 25 of file Handler.cpp.

~Handler()

virtual ~Handler ( )

virtualdefault

Member Function Documentation

description()

ParametersDescription description ( )

static

Definition at line 36 of file Handler.cpp.

name()

const std::string & name ( ) const

inherited

Definition at line 42 of file NamedModule.h.

operator!=()

template<typename T >

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

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

template<typename T >

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

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

parseCommands()

virtual Handler & parseCommands ( const std::vector< std::string > &  )

virtual

Reimplemented in CommandLineHandler, LpairHandler, and CardHandler.

Definition at line 39 of file Handler.h.

parseFile()

virtual Handler & parseFile ( const std::string &  )

virtual

Reimplemented in BoostTreeHandler, CardHandler, CommandLineHandler, and LpairHandler.

Definition at line 41 of file Handler.h.

runParameters() [1/2]

std::unique_ptr< RunParameters > & runParameters

(

)

Definition at line 46 of file Handler.h.

runParameters() [2/2]

const RunParameters * runParameters

(

)

const

Definition at line 45 of file Handler.h.

setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

template<typename T >

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

Definition at line 62 of file SteeredObject.h.

setRunParameters()

Handler & setRunParameters ( const RunParameters *  params )

virtual

Reimplemented in BoostTreeHandler.

Definition at line 31 of file Handler.cpp.

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.

write()

virtual void write ( const std::string &  ) const

virtual

Reimplemented in LpairHandler.

Definition at line 42 of file Handler.h.

Member Data Documentation

filename_

const std::string filename_

protected

Definition at line 49 of file Handler.h.

name_

const std::string name_

protectedinherited

Definition at line 45 of file NamedModule.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.