ATLAS Offline Software
Public Member Functions | List of all members
IBkgStreamsCache Class Referenceabstract

Interface to in-memory cache for pileup events. More...

#include <IBkgStreamsCache.h>

Inheritance diagram for IBkgStreamsCache:
Collaboration diagram for IBkgStreamsCache:

Public Member Functions

virtual StatusCode setup (int firstXing, unsigned int nXings, unsigned int firstStore, IBeamIntensity *iBM)=0
 
virtual void newEvent ()=0
 inform concrete cache that we start overlaying a new event More...
 
virtual void resetEvtsPerXingScaleFactor (float sf)=0
 rescale number of events per crossing More...
 
virtual StatusCode addSubEvts (unsigned int iXing, xAOD::EventInfo *overEvent, int t0BinCenter, bool loadEventProxies, unsigned int BCID)=0
 Read input events in bkg stores and link them to overlay store. More...
 
virtual StatusCode addSubEvts (unsigned int iXing, xAOD::EventInfo *overlaidEvent, int t0BinCenter)=0
 Read input events in bkg stores and link them to overlay store. More...
 
virtual unsigned int nStores () const =0
 how many stores in cache More...
 
 DeclareInterfaceID (IBkgStreamsCache, 1, 0)
 Creates the InterfaceID and interfaceID() method. More...
 

Detailed Description

Interface to in-memory cache for pileup events.

Definition at line 24 of file IBkgStreamsCache.h.

Member Function Documentation

◆ addSubEvts() [1/2]

virtual StatusCode IBkgStreamsCache::addSubEvts ( unsigned int  iXing,
xAOD::EventInfo overEvent,
int  t0BinCenter,
bool  loadEventProxies,
unsigned int  BCID 
)
pure virtual

Read input events in bkg stores and link them to overlay store.

Parameters
iXingoffset to first xing number (=0 first Xing, =nXings for last xing)
overlaidEventreference to resulting overlaid event
t0BinCentertime wrto t0 of current bin center in ns
BCIDbunch-crossing ID of signal bunch crossing
loadEventProxiesshould we load the event proxies or not.

◆ addSubEvts() [2/2]

virtual StatusCode IBkgStreamsCache::addSubEvts ( unsigned int  iXing,
xAOD::EventInfo overlaidEvent,
int  t0BinCenter 
)
pure virtual

Read input events in bkg stores and link them to overlay store.

Parameters
iXingoffset to first xing number (=0 first Xing, =nXings for last xing)
overlaidEventreference to resulting overlaid event
t0BinCentertime wrto t0 of current bin center in ns

◆ DeclareInterfaceID()

IBkgStreamsCache::DeclareInterfaceID ( IBkgStreamsCache  ,
,
 
)

Creates the InterfaceID and interfaceID() method.

◆ newEvent()

virtual void IBkgStreamsCache::newEvent ( )
pure virtual

inform concrete cache that we start overlaying a new event

◆ nStores()

virtual unsigned int IBkgStreamsCache::nStores ( ) const
pure virtual

how many stores in cache

◆ resetEvtsPerXingScaleFactor()

virtual void IBkgStreamsCache::resetEvtsPerXingScaleFactor ( float  sf)
pure virtual

rescale number of events per crossing

◆ setup()

virtual StatusCode IBkgStreamsCache::setup ( int  firstXing,
unsigned int  nXings,
unsigned int  firstStore,
IBeamIntensity iBM 
)
pure virtual
Parameters
firstXingindex of first xing to be processed (0=t0)
nXingsnumber of bunch Xings to be processed
firstStoreid of first store in cache

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