Algorithm for filling the beam position variables on xAOD::EventInfo. More...

#include <EventInfoBeamSpotDecoratorAlg.h>

Inheritance diagram for xAODMaker::EventInfoBeamSpotDecoratorAlg:

Collaboration diagram for xAODMaker::EventInfoBeamSpotDecoratorAlg:

Public Member Functions
	AthReentrantAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters: More...

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Function(s) implemented from @c AthReentrantAlgorithm
virtual StatusCode	initialize () override
	Function initialising the algorithm. More...

virtual StatusCode	execute (const EventContext &ctx) const override
	Function executing the algorithm. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Algorithm properties
SG::ReadCondHandleKey< InDet::BeamSpotData >	m_beamSpotKey
	Conditions object with the beamspot information. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosXKey
	Decorator handle for `beamPosX`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosYKey
	Decorator handle for `beamPosY`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosZKey
	Decorator handle for `beamPosZ`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosSigmaXKey
	Decorator handle for `beamPosSigmaX`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosSigmaYKey
	Decorator handle for `beamPosSigmaY`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosSigmaZKey
	Decorator handle for `beamPosSigmaZ`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamPosSigmaXYKey
	Decorator handle for `beamPosSigmaXY`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamTiltXZKey
	Decorator handle for `beamTiltXZ`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamTiltYZKey
	Decorator handle for `beamTiltYZ`. More...

SG::WriteDecorHandleKey< xAOD::EventInfo >	m_beamStatusKey
	Decorator handle for `beamStatus`. More...

Detailed Description

Algorithm for filling the beam position variables on xAOD::EventInfo.

These variables need to be filled as decorations for data. This algorithm takes care of doing that.

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 26 of file EventInfoBeamSpotDecoratorAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ AthReentrantAlgorithm()

AthReentrantAlgorithm::AthReentrantAlgorithm

Constructor with parameters:

Definition at line 90 of file AthReentrantAlgorithm.cxx.

                                                                          :
   ::AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>   ( name, pSvcLocator )
 {
  
   // Set up to run AthAlgorithmDHUpdate in sysInitialize before
   // merging depedency lists.  This extends the output dependency
   // list with any symlinks implied by inheritance relations.
   m_updateDataHandles =
     std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
     (m_extendedExtraObjects,
      std::move (m_updateDataHandles));
 }

◆ cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode xAODMaker::EventInfoBeamSpotDecoratorAlg::execute ( const EventContext & ctx ) const

overridevirtual

Function executing the algorithm.

Definition at line 61 of file EventInfoBeamSpotDecoratorAlg.cxx.

                                                                          {
  
       // Read in the condition object.
       SG::ReadCondHandle< InDet::BeamSpotData >
          beamSpotHandle( m_beamSpotKey, ctx );
       const InDet::BeamSpotData* beamSpotData = beamSpotHandle.retrieve();
       ATH_CHECK( beamSpotData != nullptr );
  
       // Set all of the decorations on the EventInfo object.
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosXHandle( m_beamPosXKey, ctx );
       beamPosXHandle( *beamPosXHandle ) = beamSpotData->beamPos()[ Amg::x ];
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosYHandle( m_beamPosYKey, ctx );
       beamPosYHandle( *beamPosYHandle ) = beamSpotData->beamPos()[ Amg::y ];
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosZHandle( m_beamPosZKey, ctx );
       beamPosZHandle( *beamPosZHandle ) = beamSpotData->beamPos()[ Amg::z ];
  
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosSigmaXHandle( m_beamPosSigmaXKey, ctx );
       beamPosSigmaXHandle( *beamPosSigmaXHandle ) =
          beamSpotData->beamSigma( 0 );
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosSigmaYHandle( m_beamPosSigmaYKey, ctx );
       beamPosSigmaYHandle( *beamPosSigmaYHandle ) =
          beamSpotData->beamSigma( 1 );
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosSigmaZHandle( m_beamPosSigmaZKey, ctx );
       beamPosSigmaZHandle( *beamPosSigmaZHandle ) =
          beamSpotData->beamSigma( 2 );
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamPosSigmaXYHandle( m_beamPosSigmaXYKey, ctx );
       beamPosSigmaXYHandle( *beamPosSigmaXYHandle ) =
          beamSpotData->beamSigmaXY();
  
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamTiltXZHandle( m_beamTiltXZKey, ctx );
       beamTiltXZHandle( *beamTiltXZHandle ) = beamSpotData->beamTilt( 0 );
       SG::WriteDecorHandle< xAOD::EventInfo, float >
          beamTiltYZHandle( m_beamTiltYZKey, ctx );
       beamTiltYZHandle( *beamTiltYZHandle ) = beamSpotData->beamTilt( 1 );
  
       SG::WriteDecorHandle< xAOD::EventInfo, uint32_t >
          beamStatusHandle( m_beamStatusKey, ctx );
       beamStatusHandle( *beamStatusHandle ) = beamSpotData->beamStatus();
  
       // Return gracefully.
       return StatusCode::SUCCESS;
    }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 79 of file AthReentrantAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ initialize()

StatusCode xAODMaker::EventInfoBeamSpotDecoratorAlg::initialize ( )

overridevirtual

Function initialising the algorithm.

Definition at line 20 of file EventInfoBeamSpotDecoratorAlg.cxx.

                                                         {
  
       // Initialise all of the keys.
       ATH_CHECK( m_beamSpotKey.initialize() );
  
       ATH_CHECK( m_beamPosXKey.initialize() );
       ATH_CHECK( m_beamPosYKey.initialize() );
       ATH_CHECK( m_beamPosZKey.initialize() );
  
       ATH_CHECK( m_beamPosSigmaXKey.initialize() );
       ATH_CHECK( m_beamPosSigmaYKey.initialize() );
       ATH_CHECK( m_beamPosSigmaZKey.initialize() );
       ATH_CHECK( m_beamPosSigmaXYKey.initialize() );
  
       ATH_CHECK( m_beamTiltXZKey.initialize() );
       ATH_CHECK( m_beamTiltYZKey.initialize() );
  
       ATH_CHECK( m_beamStatusKey.initialize() );
  
       // Greet the user.
       ATH_MSG_INFO( "Creating beamspot decorations on "
                     << m_beamPosXKey.contHandleKey().fullKey() << " from "
                     << m_beamSpotKey.fullKey() );
       ATH_MSG_DEBUG( "Keys used by the algorithm:" );
       ATH_MSG_DEBUG( "  - " << m_beamSpotKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosXKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosYKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosZKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosSigmaXKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosSigmaYKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosSigmaZKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamPosSigmaXYKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamTiltXZKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamTiltYZKey.fullKey() );
       ATH_MSG_DEBUG( "  - " << m_beamStatusKey.fullKey() );
  
       // Return gracefully.
       return StatusCode::SUCCESS;
    }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, InDet::SiSPGNNTrackMaker, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, ITkStripCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

 {
   return Gaudi::Algorithm::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                 {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_beamPosSigmaXKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosSigmaXKey

private

Initial value:

{ this,
         "beamPosSigmaXKey", "EventInfo.beamPosSigmaX",
         "Key for the beamPosSigmaX decoration" }

Decorator handle for beamPosSigmaX.

Definition at line 64 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamPosSigmaXYKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosSigmaXYKey

private

Initial value:

{ this,
         "beamPosSigmaXYKey", "EventInfo.beamPosSigmaXY",
         "Key for the beamPosSigmaXY decoration" }

Decorator handle for beamPosSigmaXY.

Definition at line 76 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamPosSigmaYKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosSigmaYKey

private

Initial value:

{ this,
         "beamPosSigmaYKey", "EventInfo.beamPosSigmaY",
         "Key for the beamPosSigmaY decoration" }

Decorator handle for beamPosSigmaY.

Definition at line 68 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamPosSigmaZKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosSigmaZKey

private

Initial value:

{ this,
         "beamPosSigmaZKey", "EventInfo.beamPosSigmaZ",
         "Key for the beamPosSigmaZ decoration" }

Decorator handle for beamPosSigmaZ.

Definition at line 72 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamPosXKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosXKey

private

Initial value:

{ this,
         "beamPosXKey", "EventInfo.beamPosX",
         "Key for the beamPosX decoration" }

Decorator handle for beamPosX.

Definition at line 51 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamPosYKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosYKey

private

Initial value:

{ this,
         "beamPosYKey", "EventInfo.beamPosY",
         "Key for the beamPosY decoration" }

Decorator handle for beamPosY.

Definition at line 55 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamPosZKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamPosZKey

private

Initial value:

{ this,
         "beamPosZKey", "EventInfo.beamPosZ",
         "Key for the beamPosZ decoration" }

Decorator handle for beamPosZ.

Definition at line 59 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamSpotKey

SG::ReadCondHandleKey< InDet::BeamSpotData > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamSpotKey

private

Initial value:

{ this,

"BeamSpotKey", "BeamSpotData", "SG key for beam spot" }

Conditions object with the beamspot information.

Definition at line 47 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamStatusKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamStatusKey

private

Initial value:

{ this,
         "beamStatusKey", "EventInfo.beamStatus",
         "Key for the beamStatus decoration" }

Decorator handle for beamStatus.

Definition at line 90 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamTiltXZKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamTiltXZKey

private

Initial value:

{ this,
         "beamTiltXZKey", "EventInfo.beamTiltXZ",
         "Key for the beamTiltXZ decoration" }

Decorator handle for beamTiltXZ.

Definition at line 81 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_beamTiltYZKey

SG::WriteDecorHandleKey< xAOD::EventInfo > xAODMaker::EventInfoBeamSpotDecoratorAlg::m_beamTiltYZKey

private

Initial value:

{ this,
         "beamTiltYZKey", "EventInfo.beamTiltYZ",
         "Key for the beamTiltYZ decoration" }

Decorator handle for beamTiltYZ.

Definition at line 85 of file EventInfoBeamSpotDecoratorAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ AthReentrantAlgorithm()

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beamPosSigmaXKey

◆ m_beamPosSigmaXYKey

◆ m_beamPosSigmaYKey

◆ m_beamPosSigmaZKey

◆ m_beamPosXKey

◆ m_beamPosYKey

◆ m_beamPosZKey

◆ m_beamSpotKey

◆ m_beamStatusKey

◆ m_beamTiltXZKey

◆ m_beamTiltYZKey

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_varHandleArraysDeclared

◆ m_vhka