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
struct	PileUpMixtureID
	Unique pile-up mixture identifier definition. More...
class	StreamTag
	Class describing a stream tag on the event. More...
class	SubEvent
	Class describing the properties of one pileup sub-event. More...

Public Types
using	TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor
template<class T, class ALLOC = AuxAllocator_t<T>>
using	ConstAccessor = SG::ConstAccessor<T, ALLOC>
template<class T, class ALLOC = AuxAllocator_t<T>>
using	Accessor = SG::Accessor<T, ALLOC>
template<class T, class ALLOC = AuxAllocator_t<T>>
using	Decorator = SG::Decorator<T, ALLOC>

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.
void	assign (const AuxElement &other, bool warnUnlocked=false)
	Assignment.
const SG::AuxVectorData *	container () const
	Return the container holding this element.
SG::AuxVectorData *	container ()
	Return the container holding this element.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type	auxdata (const std::string &name, const std::string &clsname)
	Fetch an aux data variable, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdata (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type	auxdataConst (const std::string &name, const std::string &clsname) const
	Fetch an aux data variable, as a const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailable (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for reading.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritable (const std::string &name, const std::string &clsname="")
	Check if an aux variable is available for writing.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED bool	isAvailableWritableAsDecoration (const std::string &name, const std::string &clsname="") const
	Check if an aux variable is available for writing as a decoration.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name) const
	Fetch an aux decoration, as a non-const reference.
template<class T, class ALLOC = AuxAllocator_t<T>>
XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type	auxdecor (const std::string &name, const std::string &clsname) const
	Fetch an aux decoration, as a non-const reference.
void	makePrivateStore ()
	Create a new (empty) private store for this object.
template<class U1>
void	makePrivateStore (const U1 &other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
template<class U1>
void	makePrivateStore (const U1 *other, bool warnUnlocked=false)
	Create a new private store for this object and copy aux data.
void	releasePrivateStore ()
	Release and free any private store associated with this object.
void	setStore (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	setStore (SG::IAuxStore *store)
	Set the store associated with this object.
void	setStore (const DataLink< SG::IConstAuxStore > &store)
	Set the store associated with this object.
void	setConstStore (const SG::IConstAuxStore *store)
	Synonym for setStore with IConstAuxStore.
void	setNonConstStore (SG::IAuxStore *store)
	Synonym for setStore with IAuxStore.
bool	usingPrivateStore () const
	Test to see if this object is currently using a private store.
bool	usingStandaloneStore () const
	Test to see if this object is currently using a standalone store.
const SG::IConstAuxStore *	getConstStore () const
	Return the current store, as a const interface.
SG::IAuxStore *	getStore () const
	Return the current store, as a non-const interface.
void	clearCache ()
	Clear the cached aux data pointers.
const SG::auxid_set_t &	getAuxIDs () const
	Return a set of identifiers for existing data items for this object.
const SG::auxid_set_t &	getDecorIDs () const
	Return a set of identifiers for decorations for this object.
bool	hasStore () const
	Return true if this object has an associated store.
bool	hasNonConstStore () const
	Return true if this object has an associated non-const store.
bool	clearDecorations () const
	Clear all decorations.
bool	trackIndices () const
	Return true if index tracking is enabled for this object.
size_t	index () const
	Return the index of this element within its container.
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.

Static Public Attributes
static constexpr bool	supportsThinning = true
	Mark that this type supports thinning operations.

Protected Member Functions
bool	noPrivateData () const
	True if this element has no private data.
bool	havePrivateData () const
	True if this element currently has private data.
bool	hadPrivateData () const
	True if this element had private data before it was added to its current container.

Private Types
enum class	PrivateStoreState : uint8_t { NO_PRIVATE = 0 , HAVE_PRIVATE = 1 , HAD_PRIVATE = 2 }
	The current private data state. More...

Private Member Functions
std::vector< EventInfo_v1::SubEvent >	makeSubEvents () const
void	releasePrivateStoreForDtor ()
	Out-of-line portion of destructor.
void	setIndex (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
bool	setIndexPrivate (size_t index, SG::AuxVectorData *container)
	Set the index/container for this element.
void	makePrivateStore1 (const void *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
void	makePrivateStore1 (const AuxElement *other, bool warnUnlocked)
	Create a new private store for this object and copy aux data.
AuxElementStandaloneData *	setStore1 (const SG::IConstAuxStore *store)
	Set the store associated with this object.
void	clearAux ()
	Clear all aux data associated with this element.
void	copyAux (const ConstAuxElement &other, bool warnUnlocked=false)
	Copy aux data from another object.
void	setNoPrivateData ()
	Record that this element does not have private data.
void	setHavePrivateData ()
	Record that this element currently has private data.
void	setHadPrivateData ()
	Record that this element used to have private data.

Static Private Member Functions
static void	clearAuxHelper (AuxVectorData &container, size_t index)
	Clear all aux data associated with an element.
static void	copyAuxHelper (AuxVectorData &container, size_t index, const ConstAuxElement &other, bool warnUnlocked)
	Copy aux data from another object.

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)
const SG::AuxVectorData *	m_container
	The container of which this object is an element.
size_t	m_index
	The index of this element within its container.
PrivateStoreState	m_privateStoreState

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

Accessor

template<class T, class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Accessor = SG::Accessor<T, ALLOC>

inherited

Definition at line 572 of file AuxElement.h.

ConstAccessor

template<class T, class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::ConstAccessor = SG::ConstAccessor<T, ALLOC>

inherited

Definition at line 569 of file AuxElement.h.

Decorator

template<class T, class ALLOC = AuxAllocator_t<T>>

using SG::AuxElement::Decorator = SG::Decorator<T, ALLOC>

inherited

Definition at line 575 of file AuxElement.h.

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.

TypelessConstAccessor

using SG::AuxElement::TypelessConstAccessor = ConstAuxElement::TypelessConstAccessor

inherited

Definition at line 566 of file AuxElement.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

PrivateStoreState

enum class SG::IAuxElement::PrivateStoreState : uint8_t

strongprivateinherited

The current private data state.

Enumerator
NO_PRIVATE
HAVE_PRIVATE
HAD_PRIVATE

Definition at line 131 of file IAuxElement.h.

  {
    NO_PRIVATE = 0,
    HAVE_PRIVATE = 1,
    HAD_PRIVATE = 2,
  };

Constructor & Destructor Documentation

EventInfo_v1() [1/2]

xAOD::EventInfo_v1::EventInfo_v1

(

)

Default constructor.

Definition at line 82 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 88 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 380 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 629 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;
   }

assign()

void SG::AuxElement::assign ( const AuxElement & other, bool warnUnlocked = false )

inherited

Assignment.

Parameters

other	The object from which we're assigning.
warnUnlocked	If true, then warn when we skip unlocked decorations.

We don't copy container/index, as assignment doesn't change where this object is. However, if we have aux data, then we copy aux data if we're copying from an object that also has it; otherwise, if we're copying from an object with no aux data, then we clear ours.

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.

auxdata() [1/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type SG::AuxElement::auxdata ( const std::string & name )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

auxdata() [2/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdata ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

auxdata() [3/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::reference_type SG::AuxElement::auxdata ( const std::string & name, const std::string & clsname )

inherited

Fetch an aux data variable, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

auxdata() [4/4]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdata ( const std::string & name, const std::string & clsname ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor or ConstAccessor classes.

auxdataConst() [1/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdataConst() [2/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Accessor< T, ALLOC >::const_reference_type SG::AuxElement::auxdataConst ( const std::string & name, const std::string & clsname ) const

inherited

Fetch an aux data variable, as a const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the ConstAccessor class.

auxdecor() [1/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type SG::AuxElement::auxdecor ( const std::string & name ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

auxdecor() [2/2]

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED Decorator< T, ALLOC >::reference_type SG::AuxElement::auxdecor ( const std::string & name, const std::string & clsname ) const

inherited

Fetch an aux decoration, as a non-const reference.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

If the container is locked, this will allow fetching only variables that do not yet exist (in which case they will be marked as decorations) or variables already marked as decorations.

averageInteractionsPerCrossing()

float xAOD::EventInfo_v1::averageInteractionsPerCrossing

(

)

const

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

Definition at line 397 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 970 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.

clearAux()

void SG::AuxElement::clearAux ( )

privateinherited

Clear all aux data associated with this element.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 580 of file AuxElement.cxx.

{
  if (!m_container) return;
  clearAuxHelper (*container(), index());
}

clearAuxHelper()

void SG::AuxElement::clearAuxHelper ( AuxVectorData & container, size_t index )

staticprivateinherited

Clear all aux data associated with an element.

Parameters

container	Container of the element.
index	Index of this element within the container.

If the associated aux data is const, this throws ExcConstAuxData.

Definition at line 639 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore()) {
    throw SG::ExcConstAuxData ("clearAux", SG::null_auxid);
  }
 
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    r.clear (auxid, container, index, 1);
  }
}

clearCache()

void SG::AuxElement::clearCache ( )

inherited

Clear the cached aux data pointers.

You should call this any time something changes in the aux store that could invalidate the vector pointers.

Definition at line 339 of file AuxElement.cxx.

{
  if (container())
    container()->clearCache();
}

clearDecorations()

bool SG::AuxElement::clearDecorations ( ) const

inherited

Clear all decorations.

Erase all decorations from an associated store, restoring the state to when lock was called.

Returns true if there were any decorations that were cleared, false if the store did not contain any decorations.

Definition at line 428 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->clearDecorations();
  return false;
}

clearSubEvents()

void xAOD::EventInfo_v1::clearSubEvents

(

)

Clear all the currently held sub-events.

Definition at line 647 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;
   }

container() [1/2]

SG::AuxVectorData * SG::AuxElement::container ( )

inherited

Return the container holding this element.

container() [2/2]

const SG::AuxVectorData * SG::AuxElement::container ( ) const

inherited

Return the container holding this element.

copyAux()

void SG::AuxElement::copyAux ( const ConstAuxElement & other, bool warnUnlocked = false )

privateinherited

Copy aux data from another object.

Parameters

other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

If this object has no associated store, this does nothing. If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 600 of file AuxElement.cxx.

{
  if (!m_container) return;
  copyAuxHelper (*container(), index(), other, warnUnlocked);
}

copyAuxHelper()

void SG::AuxElement::copyAuxHelper ( AuxVectorData & container, size_t index, const ConstAuxElement & other, bool warnUnlocked )

staticprivateinherited

Copy aux data from another object.

Parameters

container	Container of the element.
index	Index of this element within the container.
other	The object from which to copy.
warnUnlocked	If true, then warn when we skip unlocked decorations.

If the associated aux data is const, this throws ExcConstAuxData.

All aux data items from other are copied to this object. Any aux data items associated with this object that are not present in other are cleared. (If other has no aux data, then all aux data items for this object are cleared.)

Definition at line 667 of file AuxElement.cxx.

{
  if (!container.hasStore()) return;
  if (!container.hasNonConstStore())
    throw SG::ExcConstAuxData ("copyAux");
 
  const SG::AuxVectorData* ocont = other.container();
 
  if (!ocont || !ocont->hasStore()) {
    AuxElement::clearAuxHelper (container, index);
    return;
  }
 
#ifndef XAOD_STANDALONE
  const SG::auxid_set_t& other_decors = ocont->getDecorIDs();
#endif
  SG::auxid_set_t other_ids = ocont->getAuxIDs();
 
  size_t oindex = other.index();
  SG::AuxTypeRegistry& r = SG::AuxTypeRegistry::instance();
 
  for (SG::auxid_t auxid : other_ids) {
#ifndef XAOD_STANDALONE
    if (other_decors.test (auxid)) {
      // Don't copy decorations --- another thread may be modifying them.
      other_ids.reset (auxid);
      // Warn if we skip a decoration (except for mcEventWeights,
      // for which this is expected).
      if (warnUnlocked && r.getName(auxid) != "mcEventWeights") {
        std::ostringstream ss;
        ss << "skipped unlocked decoration " << r.getName(auxid)
           << " (" << auxid << ")";
        ATHCONTAINERS_WARNING("copyAux", ss.str());
      }
    }
    else
#endif
    if (!r.isLinked (auxid)) {
      r.copy (auxid, container, index, *ocont, oindex, 1);
    }
  }
 
  for (SG::auxid_t auxid : container.getWritableAuxIDs()) {
    if (!other_ids.test (auxid)) {
      r.clear (auxid, container, index, 1);
    }
  }
}

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 143 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 164 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 817 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 697 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.

getAuxIDs()

const SG::auxid_set_t & SG::AuxElement::getAuxIDs ( ) const

inherited

Return a set of identifiers for existing data items for this object.

If this object has a private or standalone store, then information from that will be returned. Otherwise, if this element is part of a container, then information for the container will be returned. Otherwise, return an empty set.

Definition at line 355 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getAuxIDs();
  if (container())
    return container()->getAuxIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getAuxIDs();
#endif
}

getConstStore()

const SG::IConstAuxStore * SG::AuxElement::getConstStore ( ) const

inherited

Return the current store, as a const interface.

This will be non-zero if either a const or non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 304 of file AuxElement.cxx.

{
  if (havePrivateData()) {
    return m_container->getConstStore();
  }
  return 0;
}

getDecorIDs()

const SG::auxid_set_t & SG::AuxElement::getDecorIDs ( ) const

inherited

Return a set of identifiers for decorations for this object.

   If this object has a private or standalone store, then information
   from that will be returned.  Otherwise, if this element
   is part of a container, then information for the container
   will be returned.  Otherwise, return an empty set.

Definition at line 378 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData())
    return m_container->getConstStore()->getDecorIDs();
  if (container())
    return container()->getDecorIDs();
  static const SG::auxid_set_t null_set;
  return null_set;
#else
  return ConstAuxElement::getDecorIDs();
#endif
}

getStore()

SG::IAuxStore * SG::AuxElement::getStore ( ) const

inherited

Return the current store, as a non-const interface.

This will be non-zero if a non-const store is associated with this object. This will fetch either a private or standalone store.

Definition at line 319 of file AuxElement.cxx.

{
  if (havePrivateData()) {
#ifdef ATHCONTAINERS_R21_COMPAT
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = m_container;
#else
    SG::AuxVectorData* container_nc ATLAS_THREAD_SAFE = const_cast<SG::AuxVectorData*>(container());
#endif
    return container_nc->getStore();
  }
  return 0;
}

hadPrivateData()

bool SG::IAuxElement::hadPrivateData ( ) const

protectedinherited

True if this element had private data before it was added to its current container.

hasBeamSpotWeight()

bool xAOD::EventInfo_v1::hasBeamSpotWeight

(

)

const

Check if weight for beam spot size reweighting exists.

Definition at line 966 of file EventInfo_v1.cxx.

                                              {
      return accBeamSpotWeight.isAvailable( *this );
   }

hasNonConstStore()

bool SG::AuxElement::hasNonConstStore ( ) const

inherited

Return true if this object has an associated non-const store.

This will be true for either a private or standalone store.

Definition at line 411 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasNonConstStore();
  return false;
}

hasStore()

bool SG::AuxElement::hasStore ( ) const

inherited

Return true if this object has an associated store.

This will be true for either a private or standalone store.

Definition at line 398 of file AuxElement.cxx.

{
  if (havePrivateData())
    return m_container->hasStore();
  return false;
}

havePrivateData()

bool SG::IAuxElement::havePrivateData ( ) const

protectedinherited

True if this element currently has private data.

index()

size_t SG::IAuxElement::index ( ) const

inherited

Return the index of this element within its container.

Inherited from IAuxElement.

isAvailable()

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailable ( const std::string & name, const std::string & clsname = "" ) const

inherited

Check if an aux variable is available for reading.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isAvailableWritable()

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritable ( const std::string & name, const std::string & clsname = "" )

inherited

Check if an aux variable is available for writing.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isAvailableWritableAsDecoration()

template<class T, class ALLOC = AuxAllocator_t<T>>

XAOD_AUXDATA_DEPRECATED bool SG::AuxElement::isAvailableWritableAsDecoration ( const std::string & name, const std::string & clsname = "" ) const

inherited

Check if an aux variable is available for writing as a decoration.

Parameters

name	Name of the aux variable.
clsname	The name of the associated class. May be blank.

This method has to translate from the aux data name to the internal representation each time it is called. Using this method inside of loops is discouraged; instead use the Accessor class.

isEventFlagBitSet()

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

Check one particular bit of one particular sub-detector.

Definition at line 703 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.

makePrivateStore() [1/3]

void SG::AuxElement::makePrivateStore ( )

inherited

Create a new (empty) private store for this object.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

Definition at line 192 of file AuxElement.cxx.

{
  if (m_container) {
    throw SG::ExcBadPrivateStore ("store already exists");
  }
 
  m_container = new SG::AuxElementPrivateData;
  IAuxElement::setIndex (0);
  IAuxElement::setHavePrivateData();
}

makePrivateStore() [2/3]

template<class U1>

void SG::AuxElement::makePrivateStore ( const U1 & other, bool warnUnlocked = false )

inherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

makePrivateStore() [3/3]

template<class U1>

void SG::AuxElement::makePrivateStore ( const U1 * other, bool warnUnlocked = false )

inherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

If other is an object that has aux data, then those data will be copied; otherwise, nothing will be done.

makePrivateStore1() [1/2]

void SG::AuxElement::makePrivateStore1 ( const AuxElement * other, bool warnUnlocked )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does have aux data.

Definition at line 565 of file AuxElement.cxx.

{
  makePrivateStore();
  if (other)
    this->copyAux (*other, warnUnlocked);
}

makePrivateStore1() [2/2]

void SG::AuxElement::makePrivateStore1 ( const void * other, bool warnUnlocked )

privateinherited

Create a new private store for this object and copy aux data.

Parameters

other	The object from which aux data should be copied.
warnUnlocked	If true, then warn when we skip unlocked decorations.

ExcBadPrivateStore will be thrown if this object is already associated with a store.

This overload handles the case where other does not have aux data.

makeSubEvents()

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

private

Definition at line 523 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::cerr << "xAOD::EventInfo_v1 ERROR Logic error in subEvents()"
                 << std::endl;
       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::cerr << "xAOD::EventInfo_v1 ERROR Data corruption found in "
                 << "the sub-event information" << std::endl;
       std::cerr << "subEventTime  = "
                 << ( timeAcc.isAvailable( *this ) ? timeAcc( *this ) :
                      std::vector< int16_t >() ) << std::endl;
       std::cerr << "subEventIndex  = "
                 << ( indexAcc.isAvailable( *this ) ? indexAcc( *this ) :
                      std::vector< uint16_t >() ) << std::endl;
       std::cerr << "subEventLink = "
                 << ( linkAcc.isAvailable( *this ) ? linkAcc( *this ) :
                      std::vector< ElementLink< EventInfoContainer_v1 > >() )
                 << std::endl;
       std::cerr << "subEventType  = "
                 << ( typeAcc.isAvailable( *this ) ? typeAcc( *this ) :
                      std::vector< uint16_t >() ) << std::endl;
       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 203 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.

noPrivateData()

bool SG::IAuxElement::noPrivateData ( ) const

protectedinherited

True if this element has no private data.

operator=()

EventInfo_v1 & xAOD::EventInfo_v1::operator=

(

const EventInfo_v1 &

rhs

)

Assignment operator.

Definition at line 96 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 672 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 421 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 658 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];
   }

releasePrivateStore()

void SG::AuxElement::releasePrivateStore ( )

inherited

Release and free any private store associated with this object.

ExcBadPrivateStore will be thrown if this object does not have a private store.

Definition at line 210 of file AuxElement.cxx.

{
  if (hadPrivateData()) {
    // We had a private store, but it was released because this object
    // was added to a container.  Just forget about it.
    IAuxElement::setNoPrivateData();
    return;
  }
 
  if (!havePrivateData() ||
      !m_container ||
      typeid(*m_container) != typeid(AuxElementPrivateData))
  {
    throw SG::ExcBadPrivateStore ("no private store exists");
  }
 
  IAuxElement::setIndex (0);
  IAuxElement::setNoPrivateData();
  delete m_container;
  m_container = 0;
}

releasePrivateStoreForDtor()

void SG::AuxElement::releasePrivateStoreForDtor ( )

privateinherited

Out-of-line portion of destructor.

Delete a private store if we have one.

Definition at line 441 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (havePrivateData()) {
    delete m_container;
  }
#else
  ConstAuxElement::releasePrivateStoreForDtor();
#endif
}

resetEventFlagBit()

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

Reset one particular bit of one particular sub-detector.

Definition at line 772 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 391 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 408 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 916 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 935 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 976 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.

setConstStore()

void SG::AuxElement::setConstStore ( const SG::IConstAuxStore * store )

inherited

Synonym for setStore with IConstAuxStore.

Parameters

store

The new store.

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 149 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 156 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 170 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 177 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 825 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 741 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 719 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 990 of file EventInfo_v1.cxx.

                                                     {
 
      m_evtStore = svc;
      return;
   }

setExtendedLevel1ID()

void xAOD::EventInfo_v1::setExtendedLevel1ID

(

uint32_t

value

)

Set the extended Level-1 identifier.

setHadPrivateData()

void SG::IAuxElement::setHadPrivateData ( )

privateinherited

Record that this element used to have private data.

setHavePrivateData()

void SG::IAuxElement::setHavePrivateData ( )

privateinherited

Record that this element currently has private data.

setIndex()

void SG::AuxElement::setIndex ( size_t index, SG::AuxVectorData * container )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

Usually this simply sets the index and container members of this object. However, in the case where this object has an associated private store, then we need to deal with releasing the store if the object is being added to a container, or making a new store if the object is being removed from a container.

setIndexPrivate()

bool SG::AuxElement::setIndexPrivate ( size_t index, SG::AuxVectorData * container )

privateinherited

Set the index/container for this element.

Parameters

index	The index of this object within the container.
container	The container holding this object. May be null if this object is being removed from a container.

This is called from setIndex when we have a private store to deal with.

Definition at line 505 of file AuxElement.cxx.

{
#ifdef ATHCONTAINERS_R21_COMPAT
  if (hadPrivateData()) {
    // We had a private store, but it was released because we were added
    // to a container.
 
    if (container == 0) {
      // We're being moved out of the container.  Make a new private
      // store, copy the data, and switch to it.
      auto privateData = new SG::AuxElementPrivateData;
      AuxElement to (privateData, 0);
      to.copyAux (*this);
      IAuxElement::setIndex (0);
      IAuxElement::setHavePrivateData();
      m_container = privateData;
      return true;
    }
  }
  else if (havePrivateData() &&
           typeid(*m_container) == typeid(AuxElementPrivateData))
  {
    // We currently have a private store.
 
    if (container != 0 && container != m_container) {
      // We're being added to a container.
      // Aux data has already been copied.
      // Release private store.
      IAuxElement::setIndex (index);
      IAuxElement::setHadPrivateData();
      delete m_container;
      m_container = container;
      return false;
    }
  }
  else {
    // We have a standalone store.
    throw SG::ExcBadPrivateStore ("Attempt to add/remove a standalone object "
                                  "from a container.");
  }
 
  IAuxElement::setIndex (index);
  m_container = container;
  return false;
#else
  return ConstAuxElement::setIndexPrivate (index, container);
#endif
}

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.

setNonConstStore()

void SG::AuxElement::setNonConstStore ( SG::IAuxStore * store )

inherited

Synonym for setStore with IAuxStore.

Parameters

store

The new store.

setNoPrivateData()

void SG::IAuxElement::setNoPrivateData ( )

privateinherited

Record that this element does not have private data.

setPileUpMixtureID()

void xAOD::EventInfo_v1::setPileUpMixtureID

(

const PileUpMixtureID &

value

)

Set unique pile-up mixture identifier.

Definition at line 436 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.

setStore() [1/3]

void SG::AuxElement::setStore ( const DataLink< SG::IConstAuxStore > & store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Parameters

store

Link to the new store.

Definition at line 269 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore() [2/3]

void SG::AuxElement::setStore ( const SG::IConstAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 241 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore() [3/3]

void SG::AuxElement::setStore ( SG::IAuxStore * store )

inherited

Set the store associated with this object.

Parameters

store

The new store.

If store is nonzero, this adds a standalone store to the object. The object must not be in a container and must not have a private store. If store is zero, this removes a standalone store.

Definition at line 257 of file AuxElement.cxx.

{
  AuxElementStandaloneData* data = setStore1 (store);
  if (store)
    data->setStore (store);
}

setStore1()

AuxElementStandaloneData * SG::AuxElement::setStore1 ( const SG::IConstAuxStore * store )

privateinherited

Set the store associated with this object.

Parameters

store

The new store.

Helper for setStore. Creates the AuxElementStandaloneData object if needed and returns it.

Parameters

store

The new store.

Helper for setStore. Creates the @x AuxElementStandaloneData object if needed and returns it.

Definition at line 461 of file AuxElement.cxx.

{
  if (store) {
    // Want this object be standalone.
    if (!m_container) {
      // Not in a container (and no private store).  Make a new object.
      AuxElementStandaloneData* data = new AuxElementStandaloneData;
      IAuxElement::setHavePrivateData();
      m_container = data;
      return data;
    }
    if (usingStandaloneStore()) {
      // Standalone --- return existing object.
      return static_cast<AuxElementStandaloneData*> (container());
    }
    // Otherwise, it's an error.
    throw ExcBadPrivateStore ("Attempt to attach a standalone store to an "
                              "object in a container or with a private store.");
  }
 
  else {
    // Getting rid of a standalone store.
    if (usingStandaloneStore()) {
      IAuxElement::setNoPrivateData();
      delete m_container;
      m_container = 0;
    }
    else if (m_container != 0)
      throw ExcBadPrivateStore ("Attempt to remove a standalone store from an "
                                "object in a container or with a private store.");
    return 0;
  }
}

setStreamTags()

void xAOD::EventInfo_v1::setStreamTags

(

const std::vector< StreamTag > &

value

)

Set the streams that the event was put in.

Definition at line 342 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 607 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 283 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::cerr << "<xAOD::EventInfo_v1::streamTags> ERROR "
                      << "Corrupt information found!" << std::endl;
            std::cerr << "  streamTagNames          = " << names( *this )
                      << std::endl;
            std::cerr << "  streamTagTypes          = " << types( *this )
                      << std::endl;
            std::cerr << "  streamTagObeysLumiblock = " << olb( *this )
                      << std::endl;
            std::cerr << "  streamTagRobs           = ";
            if( robsets.isAvailable( *this ) ) {
               std::cerr << "N/A" << std::endl;
            } else {
               std::cerr << robsets( *this ) << std::endl;
            }
            std::cerr << "  streamTagDets           = ";
            if( detsets.isAvailable( *this ) ) {
               std::cerr << "N/A" << std::endl;
            } else {
               std::cerr << detsets( *this ) << std::endl;
            }
         }
 
         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 596 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 996 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;
   }

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 1018 of file EventInfo_v1.cxx.

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

trackIndices()

bool SG::AuxElement::trackIndices ( ) const

inherited

Return true if index tracking is enabled for this object.

Always returns true. Included here to be consistent with AuxVectorBase when standalone objects may be used as template parameters.

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 856 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 746 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 792 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;
   }

usingPrivateStore()

bool SG::AuxElement::usingPrivateStore ( ) const

inherited

Test to see if this object is currently using a private store.

Definition at line 280 of file AuxElement.cxx.

{
  return havePrivateData() && 
    typeid(*m_container) == typeid(AuxElementPrivateData);
}

usingStandaloneStore()

bool SG::AuxElement::usingStandaloneStore ( ) const

inherited

Test to see if this object is currently using a standalone store.

Test to see if this object is currently using a private store.

Definition at line 290 of file AuxElement.cxx.

{
  return havePrivateData() &&
    typeid(*m_container) == typeid(AuxElementStandaloneData);
}

Member Data Documentation

m_container

const SG::AuxVectorData* SG::ConstAuxElement::m_container

privateinherited

The container of which this object is an element.

Should be null if this object is not within a container, except that it may also point at a private store.

Definition at line 335 of file AuxElement.h.

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 518 of file EventInfo_v1.h.

m_index

size_t SG::IAuxElement::m_index

privateinherited

The index of this element within its container.

Should be 0 if this object is not within a container.

Definition at line 128 of file IAuxElement.h.

m_privateStoreState

PrivateStoreState SG::IAuxElement::m_privateStoreState

privateinherited

Definition at line 137 of file IAuxElement.h.

m_streamTags

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

private

Cached stream tag objects.

Definition at line 511 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 513 of file EventInfo_v1.h.

supportsThinning

bool SG::AuxElement::supportsThinning = true

staticconstexprinherited

Mark that this type supports thinning operations.

See AthContainers/supportsThinning.h and AthenaPoolCnvSvc/T_AthenaPoolCnv.h. Helps guide which pool converter template will be used. If false, the default pool converter will be used rather than the aux store-specific one. Ordinary xAOD type should not touch this, but may be overridden in a derived class to handle certain special cases.

Definition at line 959 of file AuxElement.h.

---

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

• EventInfo_v1.h
• EventInfo_v1.cxx