xAOD::EventInfo_v1 Class Reference

Class describing the basic event information. More...

#include <EventInfo_v1.h>

Inheritance diagram for xAOD::EventInfo_v1:

Collaboration diagram for xAOD::EventInfo_v1:

Classes
class	StreamTag
	Class describing a stream tag on the event. More...
struct	PileUpMixtureID
	Unique pile-up mixture identifier definition. More...
class	SubEvent
	Class describing the properties of one pileup sub-event. More...

Public Member Functions
	EventInfo_v1 ()
	Default constructor.
	EventInfo_v1 (const EventInfo_v1 &parent)
	Copy constructor.
EventInfo_v1 &	operator= (const EventInfo_v1 &rhs)
	Assignment operator.
void	toPersistent ()
	Prepare the object for writing.
void	toTransient ()
	Cleanse the object after being read in.
std::string	toString () const
	Convert to a string representation.
Basic event information
uint32_t	runNumber () const
	The current event's run number.
void	setRunNumber (uint32_t value)
	Set the current event's run number.
uint64_t	eventNumber () const
	The current event's event number.
void	setEventNumber (uint64_t value)
	Set the current event's event number.
uint32_t	lumiBlock () const
	The current event's luminosity block number.
void	setLumiBlock (uint32_t value)
	Set the current event's luminosity block number.
uint32_t	timeStamp () const
	POSIX time in seconds from 1970. January 1st.
void	setTimeStamp (uint32_t value)
	Set the POSIX time of the event.
uint32_t	timeStampNSOffset () const
	Nanosecond time offset wrt. the time stamp.
void	setTimeStampNSOffset (uint32_t value)
	Set the nanosecond offset wrt. the time stamp.
uint32_t	bcid () const
	The bunch crossing ID of the event.
void	setBCID (uint32_t value)
	Set the bunch crossing ID of the event.
uint32_t	detectorMask0 () const
	Bit field indicating which TTC zones are present in the event.
void	setDetectorMask0 (uint32_t value)
	Set the bit field indicating with TTC timezones were present.
uint32_t	detectorMask1 () const
	Bit field indicating which TTC zones are present in the event.
void	setDetectorMask1 (uint32_t value)
	Set the bit field indicating with TTC timezones were present.
uint32_t	detectorMask2 () const
	Bit field indicating which TTC zones are present in the event.
void	setDetectorMask2 (uint32_t value)
	Set the bit field indicating with TTC timezones were present.
uint32_t	detectorMask3 () const
	Bit field indicating which TTC zones are present in the event.
void	setDetectorMask3 (uint32_t value)
	Set the bit field indicating with TTC timezones were present.
uint64_t	detectorMask () const
	Bit field indicating which TTC zones are present in the event.
void	setDetectorMask (uint32_t mask0, uint32_t mask1)
	Set the bit fields indicating with TTC timezones were present.
void	setDetectorMask (uint64_t mask)
	Set the bit fields indicating with TTC timezones were present.
uint64_t	detectorMaskExt () const
	Bit field indicating which TTC zones are present in the event.
void	setDetectorMaskExt (uint32_t mask2, uint32_t mask3)
	Set the bit fields indicating with TTC timezones were present.
void	setDetectorMaskExt (uint64_t mask)
	Set the bit fields indicating with TTC timezones were present.
Trigger related information
uint32_t	statusElement () const
	Trigger status element.
void	setStatusElement (uint32_t value)
	Set the trigger status element.
uint32_t	extendedLevel1ID () const
	The extended Level-1 identifier.
void	setExtendedLevel1ID (uint32_t value)
	Set the extended Level-1 identifier.
uint16_t	level1TriggerType () const
	The Level-1 trigger type.
void	setLevel1TriggerType (uint16_t value)
	Set the Level-1 trigger type.
const std::vector< StreamTag > &	streamTags () const
	Get the streams that the event was put in.
void	setStreamTags (const std::vector< StreamTag > &value)
	Set the streams that the event was put in.
Beam spot information
float	beamPosX () const
	X coordinate of the beam spot position.
float	beamPosY () const
	Y coordinate of the beam spot position.
float	beamPosZ () const
	Z coordinate of the beam spot position.
void	setBeamPos (float x, float y, float z)
	Set the beam spot position.
float	beamPosSigmaX () const
	The width of the beam spot in the X direction.
float	beamPosSigmaY () const
	The width of the beam spot in the Y direction.
float	beamPosSigmaZ () const
	The length of the beam spot in the Z direction.
void	setBeamPosSigma (float x, float y, float z)
	Set the size of the beam spot.
float	beamPosSigmaXY () const
	The beam spot shape's X-Y correlation.
void	setBeamPosSigmaXY (float value)
	Set the beam spot shape's X-Y correlation.
float	beamTiltXZ () const
	The beam's tilt in radians in XZ.
void	setBeamTiltXZ (float value)
	Set the beam's tilt in radians in XZ.
float	beamTiltYZ () const
	The beam's tilt in radians in YZ.
void	setBeamTiltYZ (float value)
	Set the beam's tilt in radians in YZ.
uint32_t	beamStatus () const
	The beam spot's status word.
void	setBeamStatus (uint32_t value)
	Set the beam spot's status word.
float	beamSpotWeight () const
	Weight for beam spot size reweighting.
bool	hasBeamSpotWeight () const
	Check if weight for beam spot size reweighting exists.
void	setBeamSpotWeight (float value)
	Set weight for beam spot size reweighting.
Functions used by pile-up digitisation
StoreGateSvc *evtStore	ATLAS_NOT_CONST_THREAD_SAFE () const
	Get the pointer to the event store associated with this event.
void	setEvtStore (StoreGateSvc *svc)
	Set the pointer to the event store associated with this event.

Private Member Functions
std::vector< EventInfo_v1::SubEvent >	makeSubEvents () const

Private Attributes
CxxUtils::CachedValue< std::vector< StreamTag > >	m_streamTags
	Cached stream tag objects.
CxxUtils::CachedValue< std::vector< SubEvent > >	m_subEvents
	Cached sub-event objects.
StoreGateSvc *	m_evtStore
	Transient pointer to the StoreGateSvc instance associated with the event (Needed for pile-up digitisation).

Event type information
enum	EventType { IS_SIMULATION = 1 , IS_TESTBEAM = 2 , IS_CALIBRATION = 4 }
	Event type codes that can be set/checked in the bitmask. More...
typedef std::vector< std::pair< std::string, std::string > >	DetDescrTags_t
	Type of the detector description tags.
const DetDescrTags_t &	detDescrTags () const
	The detector description tags.
void	setDetDescrTags (const DetDescrTags_t &value)
	Set the detector description tags.
uint32_t	mcChannelNumber () const
	The MC generator's channel number.
void	setMCChannelNumber (uint32_t value)
	Set the MC generator's channel number.
uint64_t	mcEventNumber () const
	The MC generator's event number.
void	setMCEventNumber (uint64_t value)
	Set the MC generator's event number.
const std::vector< float > &	mcEventWeights () const
	The weights of all the MC events used in the simulation.
void	setMCEventWeights (const std::vector< float > &value)
	Set the weights of all the MC events used in the simulation.
float	mcEventWeight (size_t i=0) const
	The weight of one specific MC event used in the simulation.
uint32_t	eventTypeBitmask () const
	The event type bitmask.
void	setEventTypeBitmask (uint32_t value)
	Set the event type bitmask.
bool	eventType (EventType type) const
	Check for one particular bitmask value.

Pileup information
enum	PileUpType {   Unknown = 99 , Signal = 0 , MinimumBias = 1 , Cavern = 2 ,   HaloGas = 3 , HighPtMinimumBias = 4 , ZeroBias = 5 , PileUp_NTYPES }
	Enumerator describing the types of pileup events. More...
float	actualInteractionsPerCrossing () const
	Average interactions per crossing for the current BCID - for in-time pile-up.
void	setActualInteractionsPerCrossing (float value)
	Set average interactions per crossing for the current BCID.
float	averageInteractionsPerCrossing () const
	Average interactions per crossing for all BCIDs - for out-of-time pile-up.
void	setAverageInteractionsPerCrossing (float value)
	Set average interactions per crossing for all BCIDs.
PileUpMixtureID	pileUpMixtureID () const
	Unique pile-up mixture identifier.
void	setPileUpMixtureID (const PileUpMixtureID &value)
	Set unique pile-up mixture identifier.
uint64_t	pileUpMixtureIDLowBits () const
	Unique pile-up mixture identifier low bits.
void	setPileUpMixtureIDLowBits (uint64_t value)
	Set unique pile-up mixture identifier low bits.
uint64_t	pileUpMixtureIDHighBits () const
	Unique pile-up mixture identifier high bits.
void	setPileUpMixtureIDHighBits (uint64_t value)
	Set unique pile-up mixture identifier high bits.
const std::vector< SubEvent > &	subEvents () const
	Get the pileup events that were used in the simulation.
void	setSubEvents (const std::vector< SubEvent > &value)
	Set the pileup events that were used in the simulation.
void	addSubEvent (const SubEvent &subEvent)
	Add one sub-event to the existing list.
void	clearSubEvents ()
	Clear all the currently held sub-events.
static const std::string &	PileUpType2Name (PileUpType typ)
	Convert PileUpType enum value to string.
static PileUpType	PileUpInt2Type (unsigned short typ)
	Convert int to PileUpType enum value.

Detector information
enum	EventFlagSubDet {   Pixel = 0 , SCT = 1 , TRT = 2 , LAr = 3 ,   Tile = 4 , Muon = 5 , ForwardDet = 6 , Core = 7 ,   Background = 8 , Lumi = 9 , nDets = 10 }
	Sub-detector types for which we store event-level flags. More...
enum	EventFlagErrorState { NotSet = 0 , Warning = 1 , Error = 2 }
	States that a given sub-detector could be in. More...
enum	BackgroundEventFlag {   MBTSTimeDiffHalo = 0 , MBTSTimeDiffCol = 1 , LArECTimeDiffHalo = 2 , LArECTimeDiffCol = 3 ,   PixMultiplicityHuge = 4 , PixSPNonEmpty = 5 , SCTMultiplicityHuge = 6 , SCTSPNonEmpty = 7 ,   CSCTimeDiffHalo = 8 , CSCTimeDiffCol = 9 , BCMTimeDiffHalo = 10 , BCMTimeDiffCol = 11 ,   MuonTimingCol = 12 , MuonTimingCosmic = 13 , MBTSBeamVeto = 14 , BCMBeamVeto = 15 ,   LUCIDBeamVeto = 16 , HaloMuonSegment = 17 , HaloClusterShape = 18 , HaloMuonOneSided = 19 ,   HaloMuonTwoSided = 20 , HaloTileClusterPattern = 21 , BeamGasPixel = 22 , CosmicStandAlone = 23 ,   CosmicStandAloneTight = 24 , CosmicCombined = 25 , CosmicCombinedTight = 26 , BkgdResvBit1 = 27 ,   BkgdResvBit2 = 28 , BkgdResvBit3 = 29 , BkgdResvBit4 = 30 , BkgdResvBit5 = 31 ,   NBackgroundWords = 32 }
	Enum for bits in Background EventFlag word. More...
uint32_t	eventFlags (EventFlagSubDet subDet) const
	Get the event flags for a particular sub-detector.
bool	isEventFlagBitSet (EventFlagSubDet subDet, size_t bit) const
	Check one particular bit of one particular sub-detector.
bool	setEventFlags (EventFlagSubDet subDet, uint32_t flags)
	Set the event flags for a particular sub-detector.
bool	setEventFlagBit (EventFlagSubDet subDet, size_t bit) const
	Set one particular bit of one particular sub-detector.
bool	resetEventFlagBit (EventFlagSubDet subDet, size_t bit)
	Reset one particular bit of one particular sub-detector.
EventFlagErrorState	errorState (EventFlagSubDet subDet) const
	Get the error state for a particular sub-detector.
bool	setErrorState (EventFlagSubDet subDet, EventFlagErrorState state)
	Set the error state for a particular sub-detector.
bool	updateEventFlagBit (const EventFlagSubDet subDet, const size_t bit) const
	Change detector flags with update semantics.
bool	updateEventFlags (const EventFlagSubDet subDet, const uint32_t flags_in) const
	Turn on a set of event flags for one particular sub-detector.
bool	updateErrorState (const EventFlagSubDet subDet, const EventFlagErrorState state) const
	Update the error state for one particular sub-detector.

Detailed Description

Class describing the basic event information.

This is a replacement for the offline EventInfo class, to be used in xAOD files. It stores the same information as its parent, but in much simpler format. Practically in the same format in which we store(d) event information in D3PDs.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 43 of file EventInfo_v1.h.

Member Typedef Documentation

DetDescrTags_t

typedef std::vector< std::pair< std::string, std::string > > xAOD::EventInfo_v1::DetDescrTags_t

Type of the detector description tags.

Definition at line 124 of file EventInfo_v1.h.

Member Enumeration Documentation

BackgroundEventFlag

enum xAOD::EventInfo_v1::BackgroundEventFlag

Enum for bits in Background EventFlag word.

Enumerator
MBTSTimeDiffHalo
MBTSTimeDiffCol
LArECTimeDiffHalo
LArECTimeDiffCol
PixMultiplicityHuge
PixSPNonEmpty
SCTMultiplicityHuge
SCTSPNonEmpty
CSCTimeDiffHalo
CSCTimeDiffCol
BCMTimeDiffHalo
BCMTimeDiffCol
MuonTimingCol
MuonTimingCosmic
MBTSBeamVeto
BCMBeamVeto
LUCIDBeamVeto
HaloMuonSegment
HaloClusterShape
HaloMuonOneSided
HaloMuonTwoSided
HaloTileClusterPattern
BeamGasPixel
CosmicStandAlone
CosmicStandAloneTight
CosmicCombined
CosmicCombinedTight
BkgdResvBit1
BkgdResvBit2
BkgdResvBit3
BkgdResvBit4
BkgdResvBit5
NBackgroundWords

Definition at line 353 of file EventInfo_v1.h.

                               {
         MBTSTimeDiffHalo       = 0,
         MBTSTimeDiffCol        = 1,
         LArECTimeDiffHalo      = 2,
         LArECTimeDiffCol       = 3,
         PixMultiplicityHuge    = 4,
         PixSPNonEmpty          = 5,
         SCTMultiplicityHuge    = 6,
         SCTSPNonEmpty          = 7,
         CSCTimeDiffHalo        = 8,
         CSCTimeDiffCol         = 9,
         BCMTimeDiffHalo        = 10,
         BCMTimeDiffCol         = 11,
         MuonTimingCol          = 12,
         MuonTimingCosmic       = 13,
         MBTSBeamVeto           = 14,
         BCMBeamVeto            = 15,
         LUCIDBeamVeto          = 16,
         HaloMuonSegment        = 17,
         HaloClusterShape       = 18,
         HaloMuonOneSided       = 19,
         HaloMuonTwoSided       = 20,
         HaloTileClusterPattern = 21,
         BeamGasPixel           = 22,
         CosmicStandAlone       = 23,
         CosmicStandAloneTight  = 24,
         CosmicCombined         = 25,
         CosmicCombinedTight    = 26,
         BkgdResvBit1           = 27,
         BkgdResvBit2           = 28,
         BkgdResvBit3           = 29,
         BkgdResvBit4           = 30,
         BkgdResvBit5           = 31,
         NBackgroundWords       = 32
      };

EventFlagErrorState

enum xAOD::EventInfo_v1::EventFlagErrorState

States that a given sub-detector could be in.

Enumerator
NotSet	The flag was not set to anything.
Warning	The sub-detector issued a warning.
Error	The sub-detector issued an error.

Definition at line 346 of file EventInfo_v1.h.

                               {
         NotSet  = 0, 
         Warning = 1, 
         Error   = 2  
      };

EventFlagSubDet

enum xAOD::EventInfo_v1::EventFlagSubDet

Sub-detector types for which we store event-level flags.

Enumerator
Pixel	The pixel tracker.
SCT	The SCT.
TRT	The TRT.
LAr	The LAr calorimeter.
Tile	The Tile calorimeter.
Muon	The muon spectrometer.
ForwardDet	The forward detectors.
Core	Core flags describing the event.
Background	The beam background detectors.
Lumi	The luminosity detectors.
nDets	Number of sub-detector type in this enumeration.

Definition at line 331 of file EventInfo_v1.h.

                           {
         Pixel      = 0, 
         SCT        = 1, 
         TRT        = 2, 
         LAr        = 3, 
         Tile       = 4, 
         Muon       = 5, 
         ForwardDet = 6, 
         Core       = 7, 
         Background = 8, 
         Lumi       = 9, 
         nDets      = 10 
      };

EventType

enum xAOD::EventInfo_v1::EventType

Event type codes that can be set/checked in the bitmask.

Enumerator
IS_SIMULATION	true: simulation, false: data
IS_TESTBEAM	true: testbeam, false: full detector
IS_CALIBRATION	true: calibration, false: physics

Definition at line 149 of file EventInfo_v1.h.

                     {
         IS_SIMULATION = 1,
         IS_TESTBEAM = 2,
         IS_CALIBRATION = 4
      };

PileUpType

enum xAOD::EventInfo_v1::PileUpType

Enumerator describing the types of pileup events.

Enumerator
Unknown	Type not known/specified.
Signal	The signal event.
MinimumBias	(Low pT) Minimum bias pileup event
Cavern	Cavern background pileup event.
HaloGas	Halo-gas non-collision background.
HighPtMinimumBias	High pT Minimum bias pileup event.
ZeroBias	Zero bias pileup event.
PileUp_NTYPES

Definition at line 264 of file EventInfo_v1.h.

                      {
         Unknown     = 99, 
         Signal      =  0, 
         MinimumBias =  1, 
         Cavern      =  2, 
         HaloGas     =  3, 
         HighPtMinimumBias = 4, 
         ZeroBias    = 5,  
         PileUp_NTYPES
      }; // enum PileUpType

Constructor & Destructor Documentation

EventInfo_v1() [1/2]

xAOD::EventInfo_v1::EventInfo_v1

(

)

Default constructor.

Definition at line 53 of file EventInfo_v1.cxx.

      : SG::AuxElement(), m_streamTags(),
        m_subEvents(), m_evtStore( nullptr ) {
 
   }

EventInfo_v1() [2/2]

xAOD::EventInfo_v1::EventInfo_v1

(

const EventInfo_v1 &

parent

)

Copy constructor.

Definition at line 59 of file EventInfo_v1.cxx.

      : SG::AuxElement(parent), m_streamTags(),
        m_subEvents(),
        m_evtStore( parent.m_evtStore ) {
 
      makePrivateStore( parent );
   }

Member Function Documentation

actualInteractionsPerCrossing()

float xAOD::EventInfo_v1::actualInteractionsPerCrossing

(

)

const

Average interactions per crossing for the current BCID - for in-time pile-up.

Definition at line 348 of file EventInfo_v1.cxx.

                                                           {
 
      // If the value is not available, then return 0.0, but allow users to
      // find out about this issue.
      if( ! accActualInteractionsPerCrossing.isAvailable( *this ) ) {
         xAODEventInfoPrivate::pileupUnsetHook();
         return 0.0f;
      }
      return accActualInteractionsPerCrossing( *this );
   }

addSubEvent()

void xAOD::EventInfo_v1::addSubEvent

(

const SubEvent &

subEvent

)

Add one sub-event to the existing list.

Definition at line 603 of file EventInfo_v1.cxx.

                                                            {
 
      // First, make sure that the persistent and transient variables are in
      // sync:
      subEvents();
 
      // Now, add the new sub-event:
      std::vector<SubEvent> subEvents = *m_subEvents.ptr();
      subEvents.push_back( subEvent );
      m_subEvents.store (std::move (subEvents));
      timeAcc( *this ).push_back( subEvent.time() );
      indexAcc( *this ).push_back( subEvent.index() );
      typeAcc( *this ).push_back( static_cast< uint16_t >( subEvent.type() ) );
      linkAcc( *this ).push_back( subEvent.link() );
 
      return;
   }

ATLAS_NOT_CONST_THREAD_SAFE()

StoreGateSvc *evtStore xAOD::EventInfo_v1::ATLAS_NOT_CONST_THREAD_SAFE

(

)

const

Get the pointer to the event store associated with this event.

averageInteractionsPerCrossing()

float xAOD::EventInfo_v1::averageInteractionsPerCrossing

(

)

const

Average interactions per crossing for all BCIDs - for out-of-time pile-up.

Definition at line 365 of file EventInfo_v1.cxx.

                                                            {
 
      // If the value is not available, then return 0.0, but allow users to
      // find out about this issue.
      if( ! accAverageInteractionsPerCrossing.isAvailable( *this ) ) {
         xAODEventInfoPrivate::pileupUnsetHook();
         return 0.0f;
      }
      return accAverageInteractionsPerCrossing( *this );
   }

bcid()

uint32_t xAOD::EventInfo_v1::bcid

(

)

const

The bunch crossing ID of the event.

beamPosSigmaX()

float xAOD::EventInfo_v1::beamPosSigmaX

(

)

const

The width of the beam spot in the X direction.

beamPosSigmaXY()

float xAOD::EventInfo_v1::beamPosSigmaXY

(

)

const

The beam spot shape's X-Y correlation.

beamPosSigmaY()

float xAOD::EventInfo_v1::beamPosSigmaY

(

)

const

The width of the beam spot in the Y direction.

beamPosSigmaZ()

float xAOD::EventInfo_v1::beamPosSigmaZ

(

)

const

The length of the beam spot in the Z direction.

beamPosX()

float xAOD::EventInfo_v1::beamPosX

(

)

const

X coordinate of the beam spot position.

beamPosY()

float xAOD::EventInfo_v1::beamPosY

(

)

const

Y coordinate of the beam spot position.

beamPosZ()

float xAOD::EventInfo_v1::beamPosZ

(

)

const

Z coordinate of the beam spot position.

beamSpotWeight()

float xAOD::EventInfo_v1::beamSpotWeight

(

)

const

Weight for beam spot size reweighting.

Definition at line 944 of file EventInfo_v1.cxx.

                                            {
      // If the value is not available, then return 1.0
      if( ! hasBeamSpotWeight() ) return 1.0f;
      return accBeamSpotWeight( *this );
   }

beamStatus()

uint32_t xAOD::EventInfo_v1::beamStatus

(

)

const

The beam spot's status word.

beamTiltXZ()

float xAOD::EventInfo_v1::beamTiltXZ

(

)

const

The beam's tilt in radians in XZ.

beamTiltYZ()

float xAOD::EventInfo_v1::beamTiltYZ

(

)

const

The beam's tilt in radians in YZ.

clearSubEvents()

void xAOD::EventInfo_v1::clearSubEvents

(

)

Clear all the currently held sub-events.

Definition at line 621 of file EventInfo_v1.cxx.

                                     {
 
      // Clear both the transient and persistent variables:
      m_subEvents.store (std::vector<SubEvent>());
      m_subEvents.reset();
      timeAcc( *this ).clear(); indexAcc( *this ).clear();
      typeAcc( *this ).clear(); linkAcc( *this ).clear();
 
      return;
   }

detDescrTags()

const DetDescrTags_t & xAOD::EventInfo_v1::detDescrTags

(

)

const

The detector description tags.

detectorMask()

setEventNumber setTimeStamp setBCID setDetectorMask1 setDetectorMask3 uint64_t xAOD::EventInfo_v1::detectorMask

(

)

const

Bit field indicating which TTC zones are present in the event.

Definition at line 114 of file EventInfo_v1.cxx.

                                             {
 
      return ( ( static_cast< uint64_t >( detectorMask1() ) << 32 ) |
               detectorMask0() );
   }

detectorMask0()

uint32_t xAOD::EventInfo_v1::detectorMask0

(

)

const

Bit field indicating which TTC zones are present in the event.

detectorMask1()

uint32_t xAOD::EventInfo_v1::detectorMask1

(

)

const

Bit field indicating which TTC zones are present in the event.

detectorMask2()

uint32_t xAOD::EventInfo_v1::detectorMask2

(

)

const

Bit field indicating which TTC zones are present in the event.

detectorMask3()

uint32_t xAOD::EventInfo_v1::detectorMask3

(

)

const

Bit field indicating which TTC zones are present in the event.

detectorMaskExt()

uint64_t xAOD::EventInfo_v1::detectorMaskExt

(

)

const

Bit field indicating which TTC zones are present in the event.

Definition at line 135 of file EventInfo_v1.cxx.

                                                {
 
      return ( ( static_cast< uint64_t >( detectorMask3() ) << 32 ) |
               detectorMask2() );
   }

errorState()

EventInfo_v1::EventFlagErrorState xAOD::EventInfo_v1::errorState

(

EventFlagSubDet

subDet

)

const

Get the error state for a particular sub-detector.

Definition at line 791 of file EventInfo_v1.cxx.

                                                          {
 
      // Get the value in one go:
      return static_cast< EventFlagErrorState >(
         ( ( *eventFlagsConstAccessorsV1( subDet ) )( *this ) >> EF_ERROR_SHIFT ) &
         0xF );
   }

eventFlags()

uint32_t xAOD::EventInfo_v1::eventFlags

(

EventFlagSubDet

subDet

)

const

Get the event flags for a particular sub-detector.

Definition at line 671 of file EventInfo_v1.cxx.

                                                                   {
 
      return ( ( *eventFlagsConstAccessorsV1( subDet ) )( *this ) &
               EF_BITS );
   }

eventNumber()

uint64_t xAOD::EventInfo_v1::eventNumber

(

)

const

The current event's event number.

eventType()

bool xAOD::EventInfo_v1::eventType

(

EventType

type

)

const

Check for one particular bitmask value.

eventTypeBitmask()

uint32_t xAOD::EventInfo_v1::eventTypeBitmask

(

)

const

The event type bitmask.

extendedLevel1ID()

uint32_t xAOD::EventInfo_v1::extendedLevel1ID

(

)

const

The extended Level-1 identifier.

hasBeamSpotWeight()

bool xAOD::EventInfo_v1::hasBeamSpotWeight

(

)

const

Check if weight for beam spot size reweighting exists.

Definition at line 940 of file EventInfo_v1.cxx.

                                              {
      return accBeamSpotWeight.isAvailable( *this );
   }

isEventFlagBitSet()

bool xAOD::EventInfo_v1::isEventFlagBitSet	(	EventFlagSubDet	subDet,
		size_t	bit ) const

Check one particular bit of one particular sub-detector.

Definition at line 677 of file EventInfo_v1.cxx.

                                                            {
 
      // A little sanity check:
      if( bit >= EF_ERROR_SHIFT ) {
         throw std::runtime_error( "EventInfo_v1::isEventFlagBitSet: Asked for "
                                   "non-existent bit" );
      }
 
      // Get the value of the flags:
      uint32_t value = ( *eventFlagsConstAccessorsV1( subDet ) )( *this );
 
      // Dig out the bit we are asking for:
      return ( ( value >> bit ) & 0x1 );
   }

level1TriggerType()

uint16_t xAOD::EventInfo_v1::level1TriggerType

(

)

const

The Level-1 trigger type.

lumiBlock()

uint32_t xAOD::EventInfo_v1::lumiBlock

(

)

const

The current event's luminosity block number.

makeSubEvents()

std::vector< EventInfo_v1::SubEvent > xAOD::EventInfo_v1::makeSubEvents ( ) const

private

Definition at line 491 of file EventInfo_v1.cxx.

   {
     std::vector< SubEvent > subEvents;
 
     // Check if any of the information is available:
     if( ( ! timeAcc.isAvailable( *this ) ) &&
         ( ! indexAcc.isAvailable( *this ) ) &&
         ( ! linkAcc.isAvailable( *this ) ) &&
         ( ! typeAcc.isAvailable( *this ) ) )
     {
       // If not, return right away:
       return subEvents;
     }
     // A little sanity check:
     size_t size = 0;
     if( timeAcc.isAvailable( *this ) ) {
       size = timeAcc( *this ).size();
     } else if( indexAcc.isAvailable( *this ) ) {
       size = indexAcc( *this ).size();
     } else if( linkAcc.isAvailable( *this ) ) {
       size = linkAcc( *this ).size();
     } else if( typeAcc.isAvailable( *this ) ) {
       size = typeAcc( *this ).size();
     } else {
       std::println( std::cerr, "xAOD::EventInfo_v1 ERROR Logic error in subEvents()" );
       return subEvents;
     }
     if( ( timeAcc.isAvailable( *this ) &&
           ( size != timeAcc( *this ).size() ) ) ||
         ( indexAcc.isAvailable( *this ) &&
           ( size != indexAcc( *this ).size() ) ) ||
         ( linkAcc.isAvailable( *this ) &&
           ( size != linkAcc( *this ).size() ) ) ||
         ( typeAcc.isAvailable( *this ) &&
           ( size != typeAcc( *this ).size() ) ) ) {
       std::println( std::cerr, "xAOD::EventInfo_v1 ERROR Data corruption found in "
                     "the sub-event information" );
       std::println( std::cerr, "subEventTime  = {}",
                     ( timeAcc.isAvailable( *this ) ? timeAcc( *this ) :
                       std::vector< int16_t >() ) );
       std::println( std::cerr, "subEventIndex  = {}",
                     ( indexAcc.isAvailable( *this ) ? indexAcc( *this ) :
                       std::vector< uint16_t >() ) );
 
       auto format_el = [] (const ElementLink< EventInfoContainer_v1 >& el)
       {
         return std::format ("{}:{}", el.dataID(), el.index());
       };
       const std::vector< ElementLink< EventInfoContainer_v1 > >& links =
         linkAcc.isAvailable( *this ) ? linkAcc( *this ) :
         std::vector< ElementLink< EventInfoContainer_v1 > >();
       auto linksform = links | std::views::transform (format_el);
 
       std::println( std::cerr, "subEventLink = {}", linksform );
       std::println( std::cerr,"subEventType  = {}",
                     ( typeAcc.isAvailable( *this ) ? typeAcc( *this ) :
                       std::vector< uint16_t >() ) );
       return subEvents;
     }
     // Fill up the cache:
     for( size_t i = 0; i < size; ++i ) {
       const int16_t time =
         timeAcc.isAvailable( *this ) ? timeAcc( *this )[ i ] : 0;
       const uint16_t index =
         indexAcc.isAvailable( *this ) ? indexAcc( *this )[ i ] : 0;
       const ElementLink< EventInfoContainer_v1 > link =
         linkAcc.isAvailable( *this ) ? linkAcc( *this )[ i ] :
         ElementLink< EventInfoContainer_v1 >();
       const PileUpType type =
         ( typeAcc.isAvailable( *this ) ?
           static_cast< PileUpType >( typeAcc( *this )[ i ] ) :
           Unknown );
       subEvents.emplace_back( time, index, type, link );
     }
 
     return subEvents;
   }

mcChannelNumber()

uint32_t xAOD::EventInfo_v1::mcChannelNumber

(

)

const

The MC generator's channel number.

mcEventNumber()

uint64_t xAOD::EventInfo_v1::mcEventNumber

(

)

const

The MC generator's event number.

mcEventWeight()

setMCChannelNumber setMCEventWeights float xAOD::EventInfo_v1::mcEventWeight

(

size_t

i = 0

)

const

The weight of one specific MC event used in the simulation.

Definition at line 174 of file EventInfo_v1.cxx.

                                                     {
 
      // Throw an exception when asked for an impossible index:
      return mcEventWeights().at( i );
   }

mcEventWeights()

const std::vector< float > & xAOD::EventInfo_v1::mcEventWeights

(

)

const

The weights of all the MC events used in the simulation.

operator=()

EventInfo_v1 & xAOD::EventInfo_v1::operator=

(

const EventInfo_v1 &

rhs

)

Assignment operator.

Definition at line 67 of file EventInfo_v1.cxx.

                                                                {
 
      if (&rhs != this) {
        // Clear out the caches:
        m_streamTags.store (std::vector< StreamTag >());
        m_streamTags.reset();
        m_subEvents.store (std::vector< SubEvent >());
        m_subEvents.reset();
 
        // Copy the event store pointer:
        m_evtStore = rhs.m_evtStore;
 
        // Copy the auxiliary variables:
        SG::AuxElement::operator=( rhs );
      }
 
      // Return this object:
      return *this;
   }

PileUpInt2Type()

EventInfo_v1::PileUpType xAOD::EventInfo_v1::PileUpInt2Type ( unsigned short typ )

static

Convert int to PileUpType enum value.

Definition at line 646 of file EventInfo_v1.cxx.

   {
      static const PileUpType typEnum[PileUp_NTYPES+1] = {
         Unknown /*99*/, Signal /*0*/, MinimumBias /*1*/, Cavern /*2*/, HaloGas /*3*/, ZeroBias /*4*/
      };
      int t = (typ==99)? 0: (int)typ+1;
      assert( t <= PileUp_NTYPES );
      return typEnum[t];
   }

pileUpMixtureID()

setPileUpMixtureIDHighBits EventInfo_v1::PileUpMixtureID xAOD::EventInfo_v1::pileUpMixtureID

(

)

const

Unique pile-up mixture identifier.

Definition at line 389 of file EventInfo_v1.cxx.

                                                                   {
 
      PileUpMixtureID id{};
 
      // We need to check if the values are actually stored
      if ( xAODEventInfoPrivate::accLow.isAvailable( *this )
             && xAODEventInfoPrivate::accHigh.isAvailable( *this ) ) {
         id.lowBits = pileUpMixtureIDLowBits();
         id.highBits = pileUpMixtureIDHighBits();
      }
 
      return id;
 
   }

pileUpMixtureIDHighBits()

uint64_t xAOD::EventInfo_v1::pileUpMixtureIDHighBits

(

)

const

Unique pile-up mixture identifier high bits.

pileUpMixtureIDLowBits()

uint64_t xAOD::EventInfo_v1::pileUpMixtureIDLowBits

(

)

const

Unique pile-up mixture identifier low bits.

PileUpType2Name()

const std::string & xAOD::EventInfo_v1::PileUpType2Name ( PileUpType typ )

static

Convert PileUpType enum value to string.

Definition at line 632 of file EventInfo_v1.cxx.

   {
      static const std::string typNam[PileUp_NTYPES+1] = {
         "Unknown" /*99*/,
         "Signal" /*0*/,
         "MinimumBias" /*1*/,
         "Cavern" /*2*/,
         "HaloGas"/*3*/,
         "ZeroBias"/*4*/ };
      int  t = (typ==Unknown)? 0: (int)typ+1;
      assert( t <= PileUp_NTYPES );
      return typNam[t];
   }

resetEventFlagBit()

bool xAOD::EventInfo_v1::resetEventFlagBit	(	EventFlagSubDet	subDet,
		size_t	bit )

Reset one particular bit of one particular sub-detector.

Definition at line 746 of file EventInfo_v1.cxx.

   {
      // Get the accessor:
      const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
      if( ! acc ) {
         return false;
      }
 
      // Check if the bit makes sense:
      if( bit >= EF_ERROR_SHIFT ) {
         return false;
      }
 
      // Set the new value:
      ( *acc )( *this ) &= ~( 1u << bit );
 
      // Tell the user that we were successful:
      return true;
   }

runNumber()

uint32_t xAOD::EventInfo_v1::runNumber

(

)

const

The current event's run number.

setActualInteractionsPerCrossing()

void xAOD::EventInfo_v1::setActualInteractionsPerCrossing

(

float

value

)

Set average interactions per crossing for the current BCID.

Definition at line 359 of file EventInfo_v1.cxx.

                                                                    {
 
      accActualInteractionsPerCrossing( *this ) = value;
      return;
   }

setAverageInteractionsPerCrossing()

void xAOD::EventInfo_v1::setAverageInteractionsPerCrossing

(

float

value

)

Set average interactions per crossing for all BCIDs.

Definition at line 376 of file EventInfo_v1.cxx.

                                                                     {
 
      accAverageInteractionsPerCrossing( *this ) = value;
      return;
   }

setBCID()

void xAOD::EventInfo_v1::setBCID

(

uint32_t

value

)

Set the bunch crossing ID of the event.

setBeamPos()

void xAOD::EventInfo_v1::setBeamPos	(	float	x,
		float	y,
		float	z )

Set the beam spot position.

Definition at line 890 of file EventInfo_v1.cxx.

                                                            {
 
      // The accessor objects:
      static const Accessor< float > accX( "beamPosX" );
      static const Accessor< float > accY( "beamPosY" );
      static const Accessor< float > accZ( "beamPosZ" );
 
      // Set the variables:
      accX( *this ) = x;
      accY( *this ) = y;
      accZ( *this ) = z;
 
      return;
   }

setBeamPosSigma()

void xAOD::EventInfo_v1::setBeamPosSigma	(	float	x,
		float	y,
		float	z )

Set the size of the beam spot.

Definition at line 909 of file EventInfo_v1.cxx.

                                                                 {
 
      // The accessor objects:
      static const Accessor< float > accX( "beamPosSigmaX" );
      static const Accessor< float > accY( "beamPosSigmaY" );
      static const Accessor< float > accZ( "beamPosSigmaZ" );
 
      // Set the variables:
      accX( *this ) = x;
      accY( *this ) = y;
      accZ( *this ) = z;
 
      return;
   }

setBeamPosSigmaXY()

void xAOD::EventInfo_v1::setBeamPosSigmaXY

(

float

value

)

Set the beam spot shape's X-Y correlation.

setBeamSpotWeight()

void xAOD::EventInfo_v1::setBeamSpotWeight

(

float

value

)

Set weight for beam spot size reweighting.

Definition at line 950 of file EventInfo_v1.cxx.

                                                     {
      accBeamSpotWeight( *this ) = value;
      return;
   }

setBeamStatus()

void xAOD::EventInfo_v1::setBeamStatus

(

uint32_t

value

)

Set the beam spot's status word.

setBeamTiltXZ()

void xAOD::EventInfo_v1::setBeamTiltXZ

(

float

value

)

Set the beam's tilt in radians in XZ.

setBeamTiltYZ()

void xAOD::EventInfo_v1::setBeamTiltYZ

(

float

value

)

Set the beam's tilt in radians in YZ.

setDetDescrTags()

void xAOD::EventInfo_v1::setDetDescrTags

(

const DetDescrTags_t &

value

)

Set the detector description tags.

setDetectorMask() [1/2]

void xAOD::EventInfo_v1::setDetectorMask	(	uint32_t	mask0,
		uint32_t	mask1 )

Set the bit fields indicating with TTC timezones were present.

Definition at line 120 of file EventInfo_v1.cxx.

                                                                      {
 
      setDetectorMask0( mask0 );
      setDetectorMask1( mask1 );
      return;
   }

setDetectorMask() [2/2]

void xAOD::EventInfo_v1::setDetectorMask

(

uint64_t

mask

)

Set the bit fields indicating with TTC timezones were present.

Definition at line 127 of file EventInfo_v1.cxx.

                                                     {
 
      setDetectorMask0( static_cast< uint32_t >( mask & 0xffffffff ) );
      setDetectorMask1( static_cast< uint32_t >( ( mask >> 32 ) &
                                                 0xffffffff ) );
      return;
   }

setDetectorMask0()

void xAOD::EventInfo_v1::setDetectorMask0

(

uint32_t

value

)

Set the bit field indicating with TTC timezones were present.

setDetectorMask1()

void xAOD::EventInfo_v1::setDetectorMask1

(

uint32_t

value

)

Set the bit field indicating with TTC timezones were present.

setDetectorMask2()

void xAOD::EventInfo_v1::setDetectorMask2

(

uint32_t

value

)

Set the bit field indicating with TTC timezones were present.

setDetectorMask3()

void xAOD::EventInfo_v1::setDetectorMask3

(

uint32_t

value

)

Set the bit field indicating with TTC timezones were present.

setDetectorMaskExt() [1/2]

void xAOD::EventInfo_v1::setDetectorMaskExt	(	uint32_t	mask2,
		uint32_t	mask3 )

Set the bit fields indicating with TTC timezones were present.

Definition at line 141 of file EventInfo_v1.cxx.

                                                                         {
 
      setDetectorMask2( mask2 );
      setDetectorMask3( mask3 );
      return;
   }

setDetectorMaskExt() [2/2]

void xAOD::EventInfo_v1::setDetectorMaskExt

(

uint64_t

mask

)

Set the bit fields indicating with TTC timezones were present.

Definition at line 148 of file EventInfo_v1.cxx.

                                                        {
 
      setDetectorMask2( static_cast< uint32_t >( mask & 0xffffffff ) );
      setDetectorMask3( static_cast< uint32_t >( ( mask >> 32 ) &
                                                 0xffffffff ) );
      return;
   }

setErrorState()

bool xAOD::EventInfo_v1::setErrorState	(	EventFlagSubDet	subDet,
		EventFlagErrorState	state )

Set the error state for a particular sub-detector.

Definition at line 799 of file EventInfo_v1.cxx.

                                                                 {
 
      // Get the accessor:
      const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
      if( ! acc ) {
         return false;
      }
 
      // Check its value:
      if( ( state != NotSet ) && ( state != Warning ) && ( state != Error ) ) {
         return false;
      }
 
      // Construct the new value:
      std::atomic<uint32_t>& a = (*acc)(*this);
      uint32_t orig = a;
      uint32_t value = ( ( orig & EF_BITS ) |
                         ( static_cast< uint32_t >( state ) <<
                           EF_ERROR_SHIFT ) );
      while (!a.compare_exchange_strong (orig, value)) {
        CxxUtils::stall();
        value = ( ( orig & EF_BITS ) |
                  ( static_cast< uint32_t >( state ) <<
                    EF_ERROR_SHIFT ) );
      }
 
      // Tell the user that we were successful:
      return true;
   }

setEventFlagBit()

bool xAOD::EventInfo_v1::setEventFlagBit	(	EventFlagSubDet	subDet,
		size_t	bit ) const

Set one particular bit of one particular sub-detector.

Definition at line 715 of file EventInfo_v1.cxx.

   {
     return updateEventFlagBit (subDet, bit);
   }

setEventFlags()

bool xAOD::EventInfo_v1::setEventFlags	(	EventFlagSubDet	subDet,
		uint32_t	flags )

Set the event flags for a particular sub-detector.

Definition at line 693 of file EventInfo_v1.cxx.

                                                                            {
 
      // Get the accessor:
      const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
      if( ! acc ) {
         return false;
      }
 
      // Construct the value that we want to store, taking the current error
      // flags into account:
      std::atomic<uint32_t>& a = (*acc)(*this);
      uint32_t orig = a;
      uint32_t value = ( ( orig & EF_ERROR_BITS ) | ( flags & EF_BITS ) );
      while (!a.compare_exchange_strong (orig, value)) {
        CxxUtils::stall();
        value = ( ( orig & EF_ERROR_BITS ) | ( flags & EF_BITS ) );
      }
 
      // Tell the user that we were successful:
      return true;
   }

setEventNumber()

void xAOD::EventInfo_v1::setEventNumber

(

uint64_t

value

)

Set the current event's event number.

setEventTypeBitmask()

void xAOD::EventInfo_v1::setEventTypeBitmask

(

uint32_t

value

)

Set the event type bitmask.

setEvtStore()

void xAOD::EventInfo_v1::setEvtStore

(

StoreGateSvc *

svc

)

Set the pointer to the event store associated with this event.

Definition at line 964 of file EventInfo_v1.cxx.

                                                     {
 
      m_evtStore = svc;
      return;
   }

setExtendedLevel1ID()

void xAOD::EventInfo_v1::setExtendedLevel1ID

(

uint32_t

value

)

Set the extended Level-1 identifier.

setLevel1TriggerType()

void xAOD::EventInfo_v1::setLevel1TriggerType

(

uint16_t

value

)

Set the Level-1 trigger type.

setLumiBlock()

void xAOD::EventInfo_v1::setLumiBlock

(

uint32_t

value

)

Set the current event's luminosity block number.

setMCChannelNumber()

void xAOD::EventInfo_v1::setMCChannelNumber

(

uint32_t

value

)

Set the MC generator's channel number.

setMCEventNumber()

void xAOD::EventInfo_v1::setMCEventNumber

(

uint64_t

value

)

Set the MC generator's event number.

setMCEventWeights()

void xAOD::EventInfo_v1::setMCEventWeights

(

const std::vector< float > &

value

)

Set the weights of all the MC events used in the simulation.

setPileUpMixtureID()

void xAOD::EventInfo_v1::setPileUpMixtureID

(

const PileUpMixtureID &

value

)

Set unique pile-up mixture identifier.

Definition at line 404 of file EventInfo_v1.cxx.

                                                                       {
 
      setPileUpMixtureIDLowBits( value.lowBits );
      setPileUpMixtureIDHighBits( value.highBits );
 
   }

setPileUpMixtureIDHighBits()

void xAOD::EventInfo_v1::setPileUpMixtureIDHighBits

(

uint64_t

value

)

Set unique pile-up mixture identifier high bits.

setPileUpMixtureIDLowBits()

void xAOD::EventInfo_v1::setPileUpMixtureIDLowBits

(

uint64_t

value

)

Set unique pile-up mixture identifier low bits.

setRunNumber()

void xAOD::EventInfo_v1::setRunNumber

(

uint32_t

value

)

Set the current event's run number.

setStatusElement()

void xAOD::EventInfo_v1::setStatusElement

(

uint32_t

value

)

Set the trigger status element.

setStreamTags()

void xAOD::EventInfo_v1::setStreamTags

(

const std::vector< StreamTag > &

value

)

Set the streams that the event was put in.

Definition at line 310 of file EventInfo_v1.cxx.

                                                                         {
 
      // Update the cached information:
      m_streamTags.store (value);
 
      // Clear the persistent information:
      names( *this ).clear(); types( *this ).clear(); olb( *this ).clear();
      robsets( *this ).clear(); detsets( *this ).clear();
 
      // Fill the persistent information:
      std::vector< StreamTag >::const_iterator itr = value.begin();
      std::vector< StreamTag >::const_iterator end = value.end();
      for( ; itr != end; ++itr ) {
         names( *this ).push_back( itr->name() );
         types( *this ).push_back( itr->type() );
         olb( *this ).push_back( itr->obeysLumiblock() );
         robsets( *this ).push_back( itr->robs() );
         detsets( *this ).push_back( itr->dets() );
      }
 
      return;
   }

setSubEvents()

void xAOD::EventInfo_v1::setSubEvents

(

const std::vector< SubEvent > &

value

)

Set the pileup events that were used in the simulation.

Definition at line 581 of file EventInfo_v1.cxx.

                                                                       {
 
      // Update the cached information:
      m_subEvents.store (value);
 
      // Clear the persistent information:
      timeAcc( *this ).clear(); indexAcc( *this ).clear();
      typeAcc( *this ).clear(); linkAcc( *this ).clear();
 
      // Fill the persistent information:
      std::vector< SubEvent >::const_iterator itr = value.begin();
      std::vector< SubEvent >::const_iterator end = value.end();
      for( ; itr != end; ++itr ) {
         timeAcc( *this ).push_back( itr->time() );
         indexAcc( *this ).push_back( itr->index() );
         typeAcc( *this ).push_back( static_cast< uint16_t >( itr->type() ) );
         linkAcc( *this ).push_back( itr->link() );
      }
 
      return;
   }

setTimeStamp()

void xAOD::EventInfo_v1::setTimeStamp

(

uint32_t

value

)

Set the POSIX time of the event.

setTimeStampNSOffset()

void xAOD::EventInfo_v1::setTimeStampNSOffset

(

uint32_t

value

)

Set the nanosecond offset wrt. the time stamp.

statusElement()

uint32_t xAOD::EventInfo_v1::statusElement

(

)

const

Trigger status element.

streamTags()

const std::vector< EventInfo_v1::StreamTag > & xAOD::EventInfo_v1::streamTags

(

)

const

Get the streams that the event was put in.

Definition at line 254 of file EventInfo_v1.cxx.

                                  {
 
      // Cache the new information if necessary:
      if( !m_streamTags.isValid() ) {
         std::vector< StreamTag > tags;
 
         // A little sanity check:
         if( ( names( *this ).size() != types( *this ).size() ) ||
             ( names( *this ).size() != olb( *this ).size() ) ||
             ( robsets.isAvailable( *this ) &&
               ( names( *this ).size() != robsets( *this ).size() ) ) ||
             ( detsets.isAvailable( *this ) &&
               ( names( *this ).size() != detsets( *this ).size() ) ) ) {
            std::println( std::cerr, "<xAOD::EventInfo_v1::streamTags> ERROR "
                          "Corrupt information found!" );
            std::println( std::cerr, "  streamTagNames          = {}", names( *this ) );
            std::println( std::cerr, "  streamTagTypes          = {}", types( *this ) );
            std::println( std::cerr, "  streamTagObeysLumiblock = {}", olb( *this ) );
            std::print( std::cerr, "  streamTagRobs           = " );
            if( robsets.isAvailable( *this ) ) {
               std::println( std::cerr, "N/A" );
            } else {
               std::println( std::cerr, "{}", robsets( *this ) );
            }
            std::print( std::cerr, "  streamTagDets           = " );
            if( detsets.isAvailable( *this ) ) {
               std::println( std::cerr, "N/A" );
            } else {
               std::println( std::cerr, "{}", detsets( *this ) );
            }
         }
 
         else {
           // Fill the tags.
           for( size_t i = 0; i < names( *this ).size(); ++i ) {
             static const std::set< uint32_t > dummySet;
             tags.emplace_back( names( *this )[ i ],
                                types( *this )[ i ],
                                olb( *this )[ i ],
                                ( robsets.isAvailable( *this ) ?
                                  robsets( *this )[ i ] :
                                  dummySet ),
                                ( detsets.isAvailable( *this ) ?
                                  detsets( *this )[ i ] :
                                  dummySet ) );
           }
         }
 
         // Set the cache.
         m_streamTags.set (std::move (tags));
      }
 
      // Return the cached object:
      return *m_streamTags.ptr();
   }

subEvents()

const std::vector< EventInfo_v1::SubEvent > & xAOD::EventInfo_v1::subEvents

(

)

const

Get the pileup events that were used in the simulation.

Definition at line 570 of file EventInfo_v1.cxx.

                                 {
 
      // Cache the new information if necessary:
      if( !m_subEvents.isValid() ) {
        m_subEvents.set (makeSubEvents());
      }
 
      // Return the cached vector:
      return *m_subEvents.ptr();
   }

timeStamp()

uint32_t xAOD::EventInfo_v1::timeStamp

(

)

const

POSIX time in seconds from 1970. January 1st.

timeStampNSOffset()

uint32_t xAOD::EventInfo_v1::timeStampNSOffset

(

)

const

Nanosecond time offset wrt. the time stamp.

toPersistent()

void xAOD::EventInfo_v1::toPersistent

(

)

Prepare the object for writing.

Definition at line 970 of file EventInfo_v1.cxx.

                                   {
 
      // Check if the ElementLink variable is available, and writable:
      if( linkAcc.isAvailableWritable( *this ) ) {
         // Prepare the ElementLink objects for ROOT I/O:
         std::vector< ElementLink< EventInfoContainer_v1 > >::iterator
            el_itr = linkAcc( *this ).begin();
         std::vector< ElementLink< EventInfoContainer_v1 > >::iterator
            el_end = linkAcc( *this ).end();
         for( ; el_itr != el_end; ++el_itr ) {
            el_itr->toPersistent();
         }
      }
 
      return;
   }

toString()

std::string xAOD::EventInfo_v1::toString

(

)

const

Convert to a string representation.

Definition at line 1009 of file EventInfo_v1.cxx.

                                          {
      return std::format(
         "[Run,Evt,Lumi,Time,BunchCross,DetMask] = [{},{},{},{}:{},{},{:#018x}]",
         runNumber(),
         eventNumber(),
         lumiBlock(),
         timeStamp(),
         timeStampNSOffset(),
         bcid(),
         detectorMask() );
   }

toTransient()

void xAOD::EventInfo_v1::toTransient

(

)

Cleanse the object after being read in.

As it is now fairly complicated to prepare an EventInfo object for usage after it's been read in from a branch, it seemed to make sense to put the code that's used to do this, into a separate function.

It tries to do the right thing in all situations...

Definition at line 992 of file EventInfo_v1.cxx.

                                  {
 
      m_streamTags.reset();
      m_subEvents.reset();
#ifdef XAOD_STANDALONE
      m_evtStore = nullptr;
#else
      m_evtStore = dynamic_cast<StoreGateSvc*> (Atlas::proxyDictFromEventContext());
#endif
 
      if( usingStandaloneStore() ) {
         setStore( ( SG::IAuxStore* ) nullptr );
      }
 
      return;
   }

updateErrorState()

bool xAOD::EventInfo_v1::updateErrorState	(	const EventFlagSubDet	subDet,
		const EventFlagErrorState	state ) const

Update the error state for one particular sub-detector.

The error state may only be increased by this method. If STATE is less than the current error state, then this method will return false and leave the current state unchanged.

Definition at line 830 of file EventInfo_v1.cxx.

   {
      // Check its value:
      if( ( state != NotSet ) && ( state != Warning ) && ( state != Error ) ) {
         return false;
      }
 
      // Return without trying to write if the desired state is
      // already set.
      if (errorState (subDet) == state) {
        return true;
      }
 
      // Get the accessor:
      const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
      if( ! acc ) {
         return false;
      }
 
      // Construct the new value:
      std::atomic<uint32_t>& a = (*acc)(*this);
      uint32_t orig = a;
 
      // Only allow increasing the error state in an update.
      if (state < ((orig >> EF_ERROR_SHIFT) & 0xf)) {
        return false;
      }
 
      uint32_t value = ( ( orig & EF_BITS ) |
                         ( static_cast< uint32_t >( state ) <<
                           EF_ERROR_SHIFT ) );
      while (!a.compare_exchange_strong (orig, value)) {
        if (state < ((orig >> EF_ERROR_SHIFT) & 0xf)) {
          return false;
        }
 
        value = ( ( orig & EF_BITS ) |
                  ( static_cast< uint32_t >( state ) <<
                    EF_ERROR_SHIFT ) );
 
        CxxUtils::stall();
      }
 
      // Tell the user that we were successful:
      return true;
   }

updateEventFlagBit()

bool xAOD::EventInfo_v1::updateEventFlagBit	(	const EventFlagSubDet	subDet,
		const size_t	bit ) const

Change detector flags with update semantics.

This means that we can set bits but not reset them, and that the error state can move higher (NotSet -> Warning -> Error) but not the other way. These methods are const, so they can be called on an existing EventInfo, but will fail with an exception if the detector flag word has been locked. This will happen on input if the flag word has already been set to something; it could also happen if the flag word is written explicitly with a DecorationHandle.

Be aware that no dependency tracking is done for these flags, so something that is reading them should ensure that whatever writes them runs first. In most cases, setting event flags goes along with producing some data item; in those cases, it should suffice for the reader to have a dependency on this data item. In other cases, one might need to use explicit DecorationHandle's or produce a dummy data item. Set one particular bit of one particular sub-detector

Definition at line 720 of file EventInfo_v1.cxx.

   {
      // Check if the bit makes sense:
      if( bit >= EF_ERROR_SHIFT ) {
         return false;
      }
 
      // Don't try to write if the requested flag is already set.
      uint32_t existingFlags = (*eventFlagsConstAccessorsV1( subDet ))( *this );
      if (existingFlags & (1u << bit)) {
        return true;
      }
 
      // Get the accessor:
      const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
      if( ! acc ) {
         return false;
      }
 
      // Set the new value:
      ( *acc )( *this ) |= ( 1u << bit );
 
      // Tell the user that we were successful:
      return true;
   }

updateEventFlags()

bool xAOD::EventInfo_v1::updateEventFlags	(	const EventFlagSubDet	subDet,
		const uint32_t	flags_in ) const

Turn on a set of event flags for one particular sub-detector.

This does a logical OR of the exising flags and FLAGS.

Definition at line 766 of file EventInfo_v1.cxx.

   {
      uint32_t flags = flags_in & EF_BITS;
 
      // Don't try to write if all requested flags are already set.
      uint32_t existingFlags = (*eventFlagsConstAccessorsV1( subDet ))( *this );
      if ((existingFlags | flags) ==  existingFlags) {
        return true;
      }
 
      // Get the accessor:
      const SG::AtomicDecorator< uint32_t >* acc = eventFlagsAccessorsV1( subDet );
      if( ! acc ) {
         return false;
      }
 
      // Set the new value:
      ( *acc )( *this ) |= ( flags & EF_BITS );
 
      // Tell the user that we were successful:
      return true;
   }

Member Data Documentation

m_evtStore

StoreGateSvc* xAOD::EventInfo_v1::m_evtStore

private

Transient pointer to the StoreGateSvc instance associated with the event (Needed for pile-up digitisation).

Definition at line 521 of file EventInfo_v1.h.

m_streamTags

CxxUtils::CachedValue<std::vector< StreamTag > > xAOD::EventInfo_v1::m_streamTags

private

Cached stream tag objects.

Definition at line 514 of file EventInfo_v1.h.

m_subEvents

CxxUtils::CachedValue<std::vector< SubEvent> > xAOD::EventInfo_v1::m_subEvents

private

Cached sub-event objects.

Definition at line 516 of file EventInfo_v1.h.

---

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

• EventInfo_v1.h
• EventInfo_v1.cxx