NamedModule< T > Class Template Reference

Base runtime module object. More...

#include <CepGen/Modules/NamedModule.h>

Inheritance diagram for NamedModule< T >:

Collaboration diagram for NamedModule< T >:

Public Member Functions
	NamedModule (const ParametersList &params)
	Build a module from its steering parameters.
virtual	~NamedModule ()=default
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 ()
	Describe all steering parameters for this module.

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	name_
	Module unique indexing name.
ParametersList	params_
	Module parameters.

Detailed Description

template<typename T>
class cepgen::NamedModule< T >

Template Parameters

T	Object type

Definition at line 28 of file NamedModule.h.

Constructor & Destructor Documentation

NamedModule()

template<typename T >

NamedModule ( const ParametersList &  params )

explicit

Definition at line 31 of file NamedModule.h.

~NamedModule()

template<typename T >

virtual ~NamedModule ( )

virtualdefault

Member Function Documentation

description()

template<typename T >

static ParametersDescription description ( )

static

Definition at line 36 of file NamedModule.h.

name()

template<typename T >

const std::string & name

(

)

const

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.

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.

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

name_

template<typename T >

const std::string name_

protected

Definition at line 45 of file NamedModule.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.