ThePEG::EventManipulator Class Reference

An object of the EventManipulator class may be assigned to a FullEventGenerator object. More...

#include <EventManipulator.h>

Inheritance diagram for ThePEG::EventManipulator:

Public Member Functions
virtual int	manipulate (tEHPtr eh, tEventPtr event)=0
	Manipulate an event and the event handler.
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.

Static Public Member Functions
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.

Private Member Functions
EventManipulator &	operator= (const EventManipulator &)=delete
	Private and non-existent assignment operator.

Static Private Attributes
static AbstractNoPIOClassDescription< EventManipulator >	initEventManipulator
	Describe an abstract class without persistent data.

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.
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

An object of the EventManipulator class may be assigned to a FullEventGenerator object.

The manipulate() method is called for each event generated, after the AnalysisHandlers have been called, and may manipulate the event in any way needed. The manipulator may alseo add StepHandlers to the EventHandler which produced the event. The manipulate() method returns an integer which should be zero if nothing was done to the event. If the EventHandler has steps left to do, these are performed, after which the AnalysisHandlers are called with the return value from the previous manipulate() call. Then manipulate is called again and the procedure is repeated until the EventHandler has no more steps to do.

See also

The interfaces defined for EventManipulator.

FullEventGenerator

AnalysisHandler

EventHandler

StepHandler

Definition at line 41 of file EventManipulator.h.

Member Function Documentation

manipulate()

virtual int ThePEG::EventManipulator::manipulate ( tEHPtr  eh, tEventPtr  event  )

pure virtual

Manipulate an event and the event handler.

Parameters

eh	the EventHandler in charge of the generation.
event	the Event to be manipulated.

Returns

zero if the event was not manipulated. Otherwise return an integer which will be given to the AnalysisHandlers of the current FullEventGenerator.

Member Data Documentation

initEventManipulator

AbstractNoPIOClassDescription<EventManipulator> ThePEG::EventManipulator::initEventManipulator

staticprivate

Describe an abstract class without persistent data.

Definition at line 69 of file EventManipulator.h.

---

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

• EventManipulator.h