IPileUpTool Class Reference

#include <IPileUpTool.h>

Inheritance diagram for IPileUpTool:

Collaboration diagram for IPileUpTool:

Public Member Functions
virtual StatusCode	prepareEvent (const EventContext &, unsigned int)
	called before the bunchXing loop More...
virtual StatusCode	processBunchXing (int bunchXing, SubEventIterator bSubEvents, SubEventIterator eSubEvents)=0
	called for each active bunch-crossing (time in ns) More...
virtual bool	toProcess (int bunchXing) const =0
	flags whether this tool is "live" for bunchXing (time in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing More...
virtual StatusCode	mergeEvent (const EventContext &)
	called at the end of the bunchXing loop More...
virtual StatusCode	processAllSubEvents (const EventContext &ctx)=0
	alternative interface which uses the PileUpMergeSvc to obtain all the required SubEvents. More...
virtual bool	filterPassed () const =0
	flags whether the event should be removed or not More...
virtual void	resetFilter ()=0
	reset the filter More...
	DeclareInterfaceID (IPileUpTool, 1, 0)
	Creates the InterfaceID and interfaceID() method. More...

Detailed Description

Definition at line 24 of file IPileUpTool.h.

Member Function Documentation

DeclareInterfaceID()

IPileUpTool::DeclareInterfaceID	(	IPileUpTool	,
		1	,
		0
	)

Creates the InterfaceID and interfaceID() method.

filterPassed()

virtual bool IPileUpTool::filterPassed ( ) const

pure virtual

flags whether the event should be removed or not

mergeEvent()

virtual StatusCode IPileUpTool::mergeEvent ( const EventContext &  )

inlinevirtual

called at the end of the bunchXing loop

Reimplemented in TRTDigitizationTool, and HGTD_DigitizationTool.

Definition at line 36 of file IPileUpTool.h.

{ return StatusCode::SUCCESS; }

prepareEvent()

virtual StatusCode IPileUpTool::prepareEvent ( const EventContext &  , unsigned int    )

inlinevirtual

called before the bunchXing loop

Reimplemented in HGTD_DigitizationTool, and TRTDigitizationTool.

Definition at line 27 of file IPileUpTool.h.

{ return StatusCode::SUCCESS; }

processAllSubEvents()

virtual StatusCode IPileUpTool::processAllSubEvents ( const EventContext &  ctx )

pure virtual

alternative interface which uses the PileUpMergeSvc to obtain all the required SubEvents.

Implemented in TRTDigitizationTool, and HGTD_DigitizationTool.

processBunchXing()

virtual StatusCode IPileUpTool::processBunchXing ( int  bunchXing, SubEventIterator  bSubEvents, SubEventIterator  eSubEvents  )

pure virtual

called for each active bunch-crossing (time in ns)

Implemented in TRTDigitizationTool, and HGTD_DigitizationTool.

resetFilter()

virtual void IPileUpTool::resetFilter ( )

pure virtual

reset the filter

toProcess()

virtual bool IPileUpTool::toProcess ( int  bunchXing ) const

pure virtual

flags whether this tool is "live" for bunchXing (time in ns) implemented by default in PileUpToolBase as FirstXing<=bunchXing<=LastXing

---

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

• IPileUpTool.h