RunParameters Class Reference

List of parameters used to start and run the simulation job. More...

#include <CepGen/Core/RunParameters.h>

Inheritance diagram for RunParameters:

Collaboration diagram for RunParameters:

Classes
class	Generation
	Collection of events generation parameters. More...

Public Member Functions
	RunParameters ()
	RunParameters (RunParameters &)
	Copy constructor (transfers ownership to process/event modification algorithm!)
	RunParameters (const RunParameters &)
	Const copy constructor (all but process + event handling algorithms)
	~RunParameters ()
RunParameters &	operator= (RunParameters)
	Assignment operator.
void	setTimeKeeper (utils::TimeKeeper *)
	Initialise the timekeeper instance.
utils::TimeKeeper *	timeKeeper ()
	Pointer to a timekeeper instance.
const utils::TimeKeeper *	timeKeeper () const
	Pointer to a timekeeper instance.
void	initialiseModules ()
	Initialise the event handling modules for an event generation.
ParametersList &	integrator ()
	Integrator specific user-defined parameters.
const ParametersList &	integrator () const
	Integrator specific user-defined parameters.
bool	hasProcess () const
	Is this parameters collection holding any physics process?
proc::Process &	process ()
	Process object for cross-section computation/events generation.
const proc::Process &	process () const
	Process object for cross-section computation/events generation.
std::string	processName () const
	Name of the process considered.
void	clearProcess ()
	Remove the process pointer.
void	setProcess (std::unique_ptr< proc::Process >)
	Set a process configuration.
void	setProcess (proc::Process *)
	Set a process configuration.
const Kinematics &	kinematics () const
	Events kinematics for phase space definition.
Generation &	generation ()
	Event generation parameters.
const Generation &	generation () const
	Event generation parameters.
EventModifier &	eventModifier (size_t)
	Event modification algorithm.
EventModifiersSequence &	eventModifiersSequence ()
	List of event modification algos List of event modification algos.
const EventModifiersSequence &	eventModifiersSequence () const
void	clearEventModifiersSequence ()
	Remove all event modifiers from sequence.
void	addModifier (std::unique_ptr< EventModifier >)
	Add a new event modification algorithm to the sequence.
void	addModifier (EventModifier *)
	Add a new event modification algorithm to the sequence.
EventExporter &	eventExporter (size_t)
	Output module.
EventExportersSequence &	eventExportersSequence ()
	List of output modules.
const EventExportersSequence &	eventExportersSequence () const
	List of output modules.
void	clearEventExportersSequence ()
	Remove all output modules from sequence.
void	addEventExporter (std::unique_ptr< EventExporter >)
	Set a new output module definition.
void	addEventExporter (EventExporter *)
	Set the pointer to a output module.
const TamingFunctionsSequence &	tamingFunctions () const
	List of all taming functions definitions.
void	addTamingFunction (std::unique_ptr< utils::Functional >)
	Set a new taming function definition.
void	prepareRun ()
	Reset total generation time and number of events generated for this run, prepare kinematics.
void	addGenerationTime (double gen_time)
	Add a new timing into the total generation time.
double	totalGenerationTime () const
	Total generation time in s for this run.
unsigned int	numGeneratedEvents () const
	Number of events generated in run.
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.

Friends
std::ostream &	operator<< (std::ostream &, const RunParameters &)
	User-readable dump of runtime parameters.

Detailed Description

Definition at line 41 of file RunParameters.h.

Constructor & Destructor Documentation

RunParameters() [1/3]

RunParameters

(

)

Definition at line 40 of file RunParameters.cpp.

RunParameters() [2/3]

RunParameters

(

RunParameters &

param

)

Definition at line 45 of file RunParameters.cpp.

RunParameters() [3/3]

RunParameters

(

const RunParameters &

param

)

Definition at line 57 of file RunParameters.cpp.

~RunParameters()

~RunParameters

(

)

Definition at line 64 of file RunParameters.cpp.

Member Function Documentation

addEventExporter() [1/2]

void addEventExporter

(

EventExporter *

mod

)

Definition at line 149 of file RunParameters.cpp.

addEventExporter() [2/2]

void addEventExporter

(

std::unique_ptr< EventExporter >

mod

)

Definition at line 145 of file RunParameters.cpp.

addGenerationTime()

void addGenerationTime

(

double

gen_time

)

Parameters

[in]

gen_time

Time to add (in seconds)

Definition at line 100 of file RunParameters.cpp.

addModifier() [1/2]

void addModifier

(

EventModifier *

mod

)

Definition at line 137 of file RunParameters.cpp.

addModifier() [2/2]

void addModifier

(

std::unique_ptr< EventModifier >

mod

)

Definition at line 135 of file RunParameters.cpp.

addTamingFunction()

void addTamingFunction

(

std::unique_ptr< utils::Functional >

fct

)

Definition at line 153 of file RunParameters.cpp.

clearEventExportersSequence()

void clearEventExportersSequence

(

)

Definition at line 143 of file RunParameters.cpp.

clearEventModifiersSequence()

void clearEventModifiersSequence

(

)

Definition at line 133 of file RunParameters.cpp.

clearProcess()

void clearProcess

(

)

Definition at line 115 of file RunParameters.cpp.

description()

ParametersDescription description ( )

static

Definition at line 268 of file RunParameters.cpp.

eventExporter()

EventExporter & eventExporter

(

size_t

i

)

Definition at line 141 of file RunParameters.cpp.

eventExportersSequence() [1/2]

EventExportersSequence & eventExportersSequence

(

)

Definition at line 124 of file RunParameters.h.

eventExportersSequence() [2/2]

const EventExportersSequence & eventExportersSequence

(

)

const

Definition at line 125 of file RunParameters.h.

eventModifier()

EventModifier & eventModifier

(

size_t

i

)

Definition at line 131 of file RunParameters.cpp.

eventModifiersSequence() [1/2]

EventModifiersSequence & eventModifiersSequence

(

)

Definition at line 114 of file RunParameters.h.

eventModifiersSequence() [2/2]

const EventModifiersSequence & eventModifiersSequence

(

)

const

Definition at line 116 of file RunParameters.h.

generation() [1/2]

Generation & generation

(

)

Definition at line 108 of file RunParameters.h.

generation() [2/2]

const Generation & generation

(

)

const

Definition at line 109 of file RunParameters.h.

hasProcess()

bool hasProcess

(

)

const

Definition at line 65 of file RunParameters.h.

initialiseModules()

void initialiseModules

(

)

Definition at line 79 of file RunParameters.cpp.

integrator() [1/2]

ParametersList & integrator

(

)

Definition at line 60 of file RunParameters.h.

integrator() [2/2]

const ParametersList & integrator

(

)

const

Definition at line 61 of file RunParameters.h.

kinematics()

const Kinematics & kinematics

(

)

const

Definition at line 125 of file RunParameters.cpp.

numGeneratedEvents()

unsigned int numGeneratedEvents

(

)

const

Definition at line 144 of file RunParameters.h.

operator!=()

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

inherited

Definition at line 51 of file SteeredObject.h.

operator=()

RunParameters & operator=

(

RunParameters

param

)

Definition at line 66 of file RunParameters.cpp.

operator==()

bool operator== ( const SteeredObject< RunParameters > &  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.

prepareRun()

void prepareRun

(

)

Definition at line 88 of file RunParameters.cpp.

process() [1/2]

proc::Process & process

(

)

Definition at line 105 of file RunParameters.cpp.

process() [2/2]

const proc::Process & process

(

)

const

Definition at line 107 of file RunParameters.cpp.

processName()

std::string processName

(

)

const

Definition at line 109 of file RunParameters.cpp.

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.

setProcess() [1/2]

void setProcess

(

proc::Process *

proc

)

Definition at line 119 of file RunParameters.cpp.

setProcess() [2/2]

void setProcess

(

std::unique_ptr< proc::Process >

proc

)

Definition at line 117 of file RunParameters.cpp.

setTimeKeeper()

void setTimeKeeper

(

utils::TimeKeeper *

kpr

)

Definition at line 98 of file RunParameters.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.

tamingFunctions()

const TamingFunctionsSequence & tamingFunctions

(

)

const

Definition at line 133 of file RunParameters.h.

timeKeeper() [1/2]

utils::TimeKeeper * timeKeeper

(

)

Definition at line 55 of file RunParameters.h.

timeKeeper() [2/2]

const utils::TimeKeeper * timeKeeper

(

)

const

Definition at line 56 of file RunParameters.h.

totalGenerationTime()

double totalGenerationTime

(

)

const

Definition at line 143 of file RunParameters.h.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const RunParameters &  param  )

friend

Definition at line 157 of file RunParameters.cpp.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.