StepHandler is the base class for implementing any model for a step in the event generation chain. More...

#include <StepHandler.h>

Inheritance diagram for ThePEG::StepHandler:

[legend]

Public Member Functions
Standard constructors and destructors.
virtual	~StepHandler ()
	The destructor.

Virtual functions to be implemented by concrete sub-classes.
virtual void	handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)=0
	The main function called by the EventHandler class to perform a step.

Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
virtual	~HandlerBaseT ()
	Destructor.

double	rnd () const
	Return a simple flat random number in the range ]0,1[.

double	rnd (double xu) const
	Return a simple flat random number in the range ]0,xu[.

double	rnd (double xl, double xu) const
	Return a simple flat random number in the range ]xl,xu[.

bool	rndbool () const
	Return true with 50% probability.

bool	rndbool (double p) const
	Return a true with probability p.

bool	rndbool (double p1, double p2) const
	Return a true with probability p1/(p1+p2).

int	rndsign (double p1, double p2, double p3) const
	Return -1, 0, or 1 with relative probabilities p1, p2, p3.

int	rnd2 (double p0, double p1) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1).

int	rnd3 (double p0, double p1, double p2) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1+p2).

int	rnd4 (double p0, double p1, double p2, double p3) const
	Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3).

long	irnd (long xu=2) const
	Return a simple flat random integrer number in the range [0,xu[.

long	irnd (long xl, long xu) const
	Return a simple flat random integrer number in the range [xl,xu[.

const StandardModelBase &	SM () const
	Return a reference to the object containing the standard model parameters for this run.

tSMPtr	standardModel () const
	Return a pointer to the object containing the standard model parameters for this run.

Public Member Functions inherited from ThePEG::Interfaced
virtual	~Interfaced ()
	Empty virtual destructor.

virtual bool	defaultInit ()
	Functions which are to be used during the actual event generation, after the setup is complete.

PPtr	getParticle (PID) const
	Create a new Particle instance given a id number.

PDPtr	getParticleData (PID) const
	Return a pointer to the ParticleData object corresponding to the given id number.

bool	used () const
	Returns true if this object has actally been used.

void	useMe () const
	Should be called to indicate that this object has actually been used.

tEGPtr	generator () const
	Return a pointer to the EventGenerator controlling the run.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from ThePEG::InterfacedBase
virtual	~InterfacedBase ()
	The virtual (empty) destructor;.

string	fullName () const
	Returns the full name of this object including its path, e.g.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

void	update ()
	Calls the doupdate() function with recursion prevention.

void	init ()
	Calls the doinit() function with recursion prevention.

virtual bool	preInitialize () const
	Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).

void	initrun ()
	Calls the doinitrun() function with recursion prevention.

void	finish ()
	Calls the dofinish() function with recursion prevention.

void	touch ()
	This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.

void	reset ()
	Set the state of this object to uninitialized.

void	clear ()
	Calls reset() and unTouch().

InitState	state () const
	Return the state of initialization of this object.

bool	locked () const
	Return true if the BaseRepository is not allowed to change the state of this object.

bool	touched () const
	Return true if the state of this object has been changed since the last call to update().

virtual IBPtr	fullclone () const
	Return a full clone of this object possibly doing things to the clone to make it sane.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Base
virtual	~Base ()
	The virtual destructor.

void	debug () const
	Print out debugging information for this object on std::cerr.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType	referenceCount () const
	Return the reference count.

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())
	Constructor with name.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Access to the calling EventHandler and current Step.
tEHPtr	theEventHandler
	A pointer to the (partial) collision handler which made the current call to handle().

tStepPtr	theNewStep
	A pointer to a new step if created in the last call to handle().

tStepPtr	theCurrentStep
	A pointer to the current step.

static AbstractNoPIOClassDescription< StepHandler >	initStepHandler
	Describe an abstract class without persistent data.

tEHPtr	eventHandler () const
	Get a pointer to the EventHandler which made the last call to handle().

void	eventHandler (tEHPtr)
	Set a pointer to the EventHandler which made the last call to handle().

tStepPtr	newStep ()
	Return a pointer to a new step.

tStepPtr	currentStep ()
	If a new step has been created, return it, otherwise return the current step from the eventHandler().

static void	Init ()
	Standard Init function used to initialize the interface.

void	createNewStep ()
	Use the collision handler to create a new step.

StepHandler &	operator= (const StepHandler &)=delete
	Private and non-existent assignment operator.

Additional Inherited Members
Public Types inherited from ThePEG::InterfacedBase
enum	InitState { initializing = -1 , uninitialized = 0 , initialized = 1 , runready = 2 }
	Enumeration reflecting the state of an InterfacedBase object. More...

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType
	The integer type used for counting.

Static Public Member Functions inherited from ThePEG::HandlerBase
static void	Init ()
	Standard Init function used to initialize the interface.

Static Public Member Functions inherited from ThePEG::Interfaced
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::InterfacedBase
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::Base
static void	Init ()
	The standard Init function used to initialize the interfaces.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

Protected Member Functions inherited from ThePEG::Interfaced
void	reporeg (IBPtr object, string name) const
	Register the given object in the Repository with the given name in a subdirectory with the same name as this object.

template<typename PtrT >
bool	setDefaultReference (PtrT &ptr, string classname, string objectname)
	If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.

	Interfaced ()
	Protected default constructor.

	Interfaced (const string &newName)
	Protected constructor taking a name as argument.

	Interfaced (const Interfaced &i)
	Protected copy-constructor.

void	setGenerator (tEGPtr generator)
	Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

virtual IBPtr	clone () const =0
	Return a simple clone of this object.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)
	Register an Interfaced object with the Repository.

static void	registerRepository (IBPtr, string newName)
	Register an Interfaced object with the Repository, giving it a name.

Detailed Description

StepHandler is the base class for implementing any model for a step in the event generation chain.

It has one main virtual method, handle(), which should be overridden by sub classes. The handle method is given a reference to a EventHandler, a vector of particles and a Hint as arguments. The handler is only allowed to treat particles which are in the vector. The Hint may be cast dynamically to a sub class and do whatever it wishes with the information found there. The EventHandler can be used to add other StepHandlers and Hints to modify the subsequent generation. If the StepHandler actually performs some action, the resulting particles should be added to a new Step which should be aquired with the newStep() function.

See also: The interfaces defined for StepHandler.; EventHandler; Hint; Step

Definition at line 41 of file StepHandler.h.

Member Function Documentation

◆ currentStep()

tStepPtr ThePEG::StepHandler::currentStep ( )

inline

If a new step has been created, return it, otherwise return the current step from the eventHandler().

Definition at line 102 of file StepHandler.h.

References theCurrentStep, and theNewStep.

◆ eventHandler()

tEHPtr ThePEG::StepHandler::eventHandler ( ) const

inline

Get a pointer to the EventHandler which made the last call to handle().

Definition at line 81 of file StepHandler.h.

References theEventHandler.

◆ handle()

virtual void ThePEG::StepHandler::handle	(	EventHandler &	eh,
		const tPVector &	tagged,
		const Hint &	hint
	)

pure virtual

The main function called by the EventHandler class to perform a step.

Parameters

eh	the EventHandler in charge of the Event generation.
tagged	if not empty these are the only particles which should be considered by the StepHandler.
hint	a Hint object with possible information from previously performed steps.

Exceptions

Veto	if the StepHandler requires the current step to be discarded.
Stop	if the generation of the current Event should be stopped after this call.
Exception	if something goes wrong.

Implemented in ThePEG::CascadeHandler, ThePEG::ClusterCollapser, and ThePEG::DecayHandler.

◆ newStep()

tStepPtr ThePEG::StepHandler::newStep ( )

inline

Return a pointer to a new step.

If one has alredy been created in the last call to handle(), that step will be returned.

Definition at line 93 of file StepHandler.h.

References createNewStep(), and theNewStep.

Member Data Documentation

◆ initStepHandler

AbstractNoPIOClassDescription<StepHandler> ThePEG::StepHandler::initStepHandler

staticprivate

Describe an abstract class without persistent data.

Definition at line 146 of file StepHandler.h.

◆ theCurrentStep

tStepPtr ThePEG::StepHandler::theCurrentStep

private

A pointer to the current step.

Is equal to theNewStep if one was created in the current call to handle().

Definition at line 139 of file StepHandler.h.

Referenced by currentStep().

◆ theEventHandler

tEHPtr ThePEG::StepHandler::theEventHandler

private

A pointer to the (partial) collision handler which made the current call to handle().

Definition at line 128 of file StepHandler.h.

Referenced by eventHandler().

◆ theNewStep

tStepPtr ThePEG::StepHandler::theNewStep

private

A pointer to a new step if created in the last call to handle().

Definition at line 133 of file StepHandler.h.

Referenced by currentStep(), and newStep().

The documentation for this class was generated from the following file:

StepHandler.h

Public Member Functions

Access to the calling EventHandler and current Step.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ currentStep()

◆ eventHandler()

◆ handle()

◆ newStep()

Member Data Documentation

◆ initStepHandler

◆ theCurrentStep

◆ theEventHandler

◆ theNewStep