Class template to define any hadroniser as a general object with defined methods. More...

#include <CepGen/Physics/Hadroniser.h>

Inheritance diagram for Hadroniser:

Collaboration diagram for Hadroniser:

Public Member Functions
	Hadroniser (const ParametersList &)
	Default constructor for an undefined hadroniser.

bool	fragmentRemnants () const
	Specify whether the beam remnants are to be fragmented.

void	setSeed (long long seed)
	Specify a random numbers generator seed for the external module.

virtual void	readString (const std::string &)
	Parse a configuration string.

virtual void	readStrings (const std::vector< std::string > &)
	Parse a list of configuration strings.

virtual bool	run (Event &ev, double &weight, bool fast=false)=0
	Modify an event.

virtual void	setCrossSection (const Value &)
	Specify the cross section value, in pb.

void	initialise (const RunParameters &)
	Initialise the handler and its inner parameterisation.

const RunParameters &	runParameters () const
	List of run parameters.

template<typename T >
T *	engine ()
	Retrieve the engine object.

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 ()

Protected Member Functions
virtual void	initialise ()=0

virtual void *	enginePtr ()
	Engine object.

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 bool	remn_fragm_
	Switch on/off the remnants fragmentation where applicable.

long long	seed_ {0ll}
	Random numbers generator seed fed to the algorithm.

unsigned short	max_trials_ {1}
	Maximal number of trials for the algorithm.

const std::string	name_
	Module unique indexing name.

ParametersList	params_
	Module parameters.

Detailed Description

Author: Laurent Forthomme laure.nosp@m.nt.f.nosp@m.ortho.nosp@m.mme@.nosp@m.cern..nosp@m.ch

Date: January 2014

Definition at line 32 of file Hadroniser.h.

Constructor & Destructor Documentation

◆ Hadroniser()

Hadroniser ( const ParametersList & plist )

explicit

Definition at line 24 of file Hadroniser.cpp.

Member Function Documentation

◆ description()

ParametersDescription description ( )

static

Definition at line 27 of file Hadroniser.cpp.

◆ engine()

template<typename T >

T * engine ( )

inherited

Definition at line 42 of file EventHandler.h.

◆ enginePtr()

void * enginePtr ( )

protectedvirtualinherited

Definition at line 50 of file EventHandler.cpp.

◆ fragmentRemnants()

bool fragmentRemnants ( ) const

Definition at line 40 of file Hadroniser.h.

◆ initialise() [1/2]

virtual void initialise ( )

protectedpure virtualinherited

Implemented in PhotosFilter, TauolaFilter, Pythia6Hadroniser, LHEFHandler, and Pythia8Hadroniser.

◆ initialise() [2/2]

void initialise ( const RunParameters & params )

inherited

Definition at line 36 of file EventHandler.cpp.

◆ name()

const std::string & name ( ) const

inherited

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.

◆ readString()

virtual void readString ( const std::string & )

virtualinherited

Reimplemented in Pythia6Hadroniser, and Pythia8Hadroniser.

Definition at line 39 of file EventModifier.h.

◆ readStrings()

void readStrings ( const std::vector< std::string > & params )

virtualinherited

Definition at line 31 of file EventModifier.cpp.

◆ run()

virtual bool run	(	Event &	ev,
		double &	weight,
		bool	fast = `false`
	)

pure virtualinherited

Parameters

[in,out]	ev	Input/output event
[in,out]	weight	Event weight after modification
[in]	fast	run a faster version of the algorithm (whenever available)

Returns: Boolean stating whether or not the modification occurred successfully

Implemented in PhotosFilter, TauolaFilter, Pythia6Hadroniser, and Pythia8Hadroniser.

◆ runParameters()

const RunParameters & runParameters ( ) const

inherited

Definition at line 44 of file EventHandler.cpp.

◆ setCrossSection()

virtual void setCrossSection ( const Value & )

virtualinherited

Reimplemented in Pythia8Hadroniser.

Definition at line 48 of file EventModifier.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.

◆ setSeed()

void setSeed ( long long seed )

inherited

Parameters

[in] seed A RNG seed

Definition at line 37 of file EventModifier.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

◆ max_trials_

unsigned short max_trials_ {1}

protectedinherited

Definition at line 52 of file EventModifier.h.

◆ name_

const std::string name_

protectedinherited

Definition at line 45 of file NamedModule.h.

◆ params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.

◆ remn_fragm_

const bool remn_fragm_

protected

Definition at line 44 of file Hadroniser.h.

◆ seed_

long long seed_ {0ll}

protectedinherited

Definition at line 51 of file EventModifier.h.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Hadroniser()

Member Function Documentation

◆ description()

◆ engine()

◆ enginePtr()

◆ fragmentRemnants()

◆ initialise() [1/2]

◆ initialise() [2/2]

◆ name()

◆ operator!=()

◆ operator==()

◆ parameters()

◆ readString()

◆ readStrings()

◆ run()

◆ runParameters()

◆ setCrossSection()

◆ setDescribedParameters()

◆ setParameters()

◆ setSeed()

◆ steer()

◆ steerAs()

◆ steerName()

◆ steerPath()

Member Data Documentation

◆ max_trials_

◆ name_

◆ params_

◆ remn_fragm_

◆ seed_