SteeredObject< T > Class Template Reference

Base user-steerable object. More...

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

Inherits Steerable.

Inherited by NamedModule< Coupling >, NamedModule< EventHandler >, NamedModule< Integrator >, NamedModule< PartonFlux >, NamedModule< PhaseSpaceGenerator >, NamedModule< Handler >, NamedModule< Parameterisation >, NamedModule< Process >, NamedModule< Derivator >, NamedModule< DocumentationGenerator >, NamedModule< Drawer >, NamedModule< Functional >, NamedModule< RandomGenerator >, and NamedModule< T >.

Collaboration diagram for SteeredObject< T >:

Public Member Functions
	SteeredObject ()
	Build a module.
	SteeredObject (const ParametersList &params)
	~SteeredObject () override=default
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.
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 ()
	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

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

Template Parameters

T	Object steered (using its T::description() static member)

Definition at line 41 of file SteeredObject.h.

Constructor & Destructor Documentation

SteeredObject() [1/2]

template<typename T >

SteeredObject

(

)

Definition at line 43 of file SteeredObject.h.

SteeredObject() [2/2]

template<typename T >

SteeredObject ( const ParametersList & params )

explicit

Definition at line 44 of file SteeredObject.h.

~SteeredObject()

template<typename T >

~SteeredObject ( )

overridedefault

Member Function Documentation

description()

static ParametersDescription description ( )

staticinherited

operator!=()

template<typename T >

bool operator!=

(

const SteeredObject< T > &

oth

)

const

Definition at line 50 of file SteeredObject.h.

operator==()

template<typename T >

bool operator==

(

const SteeredObject< T > &

oth

)

const

Definition at line 48 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtual

Reimplemented from Steerable.

Definition at line 53 of file SteeredObject.h.

setDescribedParameters()

template<typename T >

void setDescribedParameters

(

const ParametersList &

params_orig

)

Definition at line 72 of file SteeredObject.h.

setParameters()

template<typename T >

void setParameters ( const ParametersList & )

overridevirtual

Reimplemented from Steerable.

Definition at line 61 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

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.