Steerable Class Reference

Base runtime module object. More...

#include <include/CepGen/Core/Steerable.h>

Inheritance diagram for Steerable:

Collaboration diagram for Steerable:

Public Member Functions
	Steerable (const ParametersList &)
	Build a module from its steering parameters.
virtual	~Steerable ()=default
virtual const ParametersList &	parameters () const
	Module parameters.
virtual void	setParameters (const ParametersList &)
	Set module parameters.

Static Public Member Functions
static ParametersDescription	description ()
	Description of all object parameters.

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 recast 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 26 of file Steerable.h.

Constructor & Destructor Documentation

Steerable()

Steerable ( const ParametersList & )

explicit

~Steerable()

virtual ~Steerable ( )

virtualdefault

Member Function Documentation

description()

static ParametersDescription description ( )

static

parameters()

virtual const ParametersList & parameters ( ) const

virtual

Reimplemented in SteeredObject< T >, SteeredObject< Beam >, SteeredObject< BranchingRatios >, SteeredObject< Central >, SteeredObject< ConfigWriter >, SteeredObject< Coupling >, SteeredObject< CutsList >, SteeredObject< Derivator >, SteeredObject< DocumentationGenerator >, SteeredObject< Drawer >, SteeredObject< EFTParameters >, SteeredObject< Environment >, SteeredObject< EventHandler >, SteeredObject< Functional >, SteeredObject< Generation >, SteeredObject< GeneratorWorker >, SteeredObject< GluonGrid >, SteeredObject< GridDrawer >, SteeredObject< Handler >, SteeredObject< IncomingBeams >, SteeredObject< Initial >, SteeredObject< Integrator >, SteeredObject< Interface >, SteeredObject< Kinematics >, SteeredObject< NachtmannAmplitudes >, SteeredObject< Parameterisation >, SteeredObject< ParticleProperties >, SteeredObject< PartonFlux >, SteeredObject< PartonsPhaseSpaceGenerator >, SteeredObject< PhaseSpaceGenerator >, SteeredObject< PolarisationState >, SteeredObject< Process >, SteeredObject< ProcessVariablesAnalyser >, SteeredObject< RandomGenerator >, SteeredObject< Remnants >, SteeredObject< ResonanceObject >, SteeredObject< RunParameters >, IncomingBeams, and Kinematics.

Definition at line 33 of file Steerable.h.

setParameters()

virtual void setParameters ( const ParametersList & )

virtual

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, Kinematics, SteeredObject< T >, SteeredObject< Beam >, SteeredObject< BranchingRatios >, SteeredObject< Central >, SteeredObject< ConfigWriter >, SteeredObject< Coupling >, SteeredObject< CutsList >, SteeredObject< Derivator >, SteeredObject< DocumentationGenerator >, SteeredObject< Drawer >, SteeredObject< EFTParameters >, SteeredObject< Environment >, SteeredObject< EventHandler >, SteeredObject< Functional >, SteeredObject< Generation >, SteeredObject< GeneratorWorker >, SteeredObject< GluonGrid >, SteeredObject< GridDrawer >, SteeredObject< Handler >, SteeredObject< IncomingBeams >, SteeredObject< Initial >, SteeredObject< Integrator >, SteeredObject< Interface >, SteeredObject< Kinematics >, SteeredObject< NachtmannAmplitudes >, SteeredObject< Parameterisation >, SteeredObject< ParticleProperties >, SteeredObject< PartonFlux >, SteeredObject< PartonsPhaseSpaceGenerator >, SteeredObject< PhaseSpaceGenerator >, SteeredObject< PolarisationState >, SteeredObject< Process >, SteeredObject< ProcessVariablesAnalyser >, SteeredObject< RandomGenerator >, SteeredObject< Remnants >, SteeredObject< ResonanceObject >, and SteeredObject< RunParameters >.

steer()

template<typename T >

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

protected

Definition at line 39 of file Steerable.h.

steerAs()

template<typename T , typename U >

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

protected

Definition at line 44 of file Steerable.h.

steerName()

std::string steerName ( ) const

protected

Definition at line 48 of file Steerable.h.

steerPath()

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

protected

Member Data Documentation

params_

ParametersList params_

mutableprotected

Definition at line 50 of file Steerable.h.