RunParameters::Generation Class Reference

Collection of events generation parameters. More...

#include <CepGen/Core/RunParameters.h>

Inheritance diagram for RunParameters::Generation:

Collaboration diagram for RunParameters::Generation:

Public Member Functions
	Generation (const ParametersList &=ParametersList())
	Build a generation parameters collection from a user input.
void	setTargetLuminosity (double lumi_invpb)
	Set target luminosity, in pb^-1.
double	targetLuminosity () const
	Target luminosity to reach, in pb^-1.
void	setMaxGen (size_t max_gen)
	Set the maximal number of events to generate.
size_t	maxGen () const
	Maximal number of events to generate.
bool	enabled () const
	Are we generating events?
void	setPrintEvery (size_t print_every)
	Set the events display frequency.
size_t	printEvery () const
	Frequency at which events are displayed to the user.
void	setSymmetrise (bool sym)
	Switch the symmetrisation of the z-axis for each event.
bool	symmetrise () const
	Symmetrise events wrt the \(z\)-axis ?
void	setNumThreads (size_t nt)
	Set the number of threads for the events generation.
size_t	numThreads () const
	Number of threads to perform the events generation.
void	setNumPoints (size_t np)
	Set the number of points to probe in each integration bin.
size_t	numPoints () const
	Number of points to "shoot" in each integration bin.
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.

Detailed Description

Definition at line 81 of file RunParameters.h.

Constructor & Destructor Documentation

Generation()

Generation ( const ParametersList &  params = ParametersList() )

explicit

Definition at line 277 of file RunParameters.cpp.

Member Function Documentation

description()

ParametersDescription description ( )

static

Definition at line 287 of file RunParameters.cpp.

enabled()

bool enabled

(

)

const

Definition at line 92 of file RunParameters.h.

maxGen()

size_t maxGen

(

)

const

Definition at line 91 of file RunParameters.h.

numPoints()

size_t numPoints

(

)

const

Definition at line 100 of file RunParameters.h.

numThreads()

size_t numThreads

(

)

const

Definition at line 98 of file RunParameters.h.

operator!=()

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

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

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

printEvery()

size_t printEvery

(

)

const

Definition at line 94 of file RunParameters.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setMaxGen()

void setMaxGen

(

size_t

max_gen

)

Definition at line 90 of file RunParameters.h.

setNumPoints()

void setNumPoints

(

size_t

np

)

Definition at line 99 of file RunParameters.h.

setNumThreads()

void setNumThreads

(

size_t

nt

)

Definition at line 97 of file RunParameters.h.

setParameters()

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 of file SteeredObject.h.

setPrintEvery()

void setPrintEvery

(

size_t

print_every

)

Definition at line 93 of file RunParameters.h.

setSymmetrise()

void setSymmetrise

(

bool

sym

)

Definition at line 95 of file RunParameters.h.

setTargetLuminosity()

void setTargetLuminosity

(

double

lumi_invpb

)

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

symmetrise()

bool symmetrise

(

)

const

Definition at line 96 of file RunParameters.h.

targetLuminosity()

double targetLuminosity

(

)

const

Definition at line 89 of file RunParameters.h.

Member Data Documentation

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.