#include <FlowEnergyDecorator.h>

Inheritance diagram for FlowEnergyDecorator:

Collaboration diagram for FlowEnergyDecorator:

Public Member Functions
	FlowEnergyDecorator (const std::string &name, ISvcLocator *pSvcLocator)

virtual StatusCode	initialize () override

virtual StatusCode	execute (const EventContext &) const override

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, V, H > &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

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, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

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

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

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

Private Attributes
SG::ReadHandleKey< xAOD::FlowElementContainer >	m_FlowContainerKey

SG::ReadHandleKey< xAOD::FlowElementContainer >	m_PFlowContainerKey

SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_eEMKey

SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_eHADKey

SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_eFracEMKey

SG::WriteDecorHandleKey< xAOD::FlowElementContainer >	m_eFracHADKey

SG::ReadDecorHandleKeyArray< xAOD::FlowElementContainer >	m_emReadDecorKeys

SG::WriteDecorHandleKeyArray< xAOD::FlowElementContainer >	m_emWriteDecorKeys

SG::ReadDecorHandleKeyArray< xAOD::FlowElementContainer >	m_hadReadDecorKeys

SG::WriteDecorHandleKeyArray< xAOD::FlowElementContainer >	m_hadWriteDecorKeys

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

Detailed Description

Definition at line 23 of file FlowEnergyDecorator.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ FlowEnergyDecorator()

FlowEnergyDecorator::FlowEnergyDecorator	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 15 of file FlowEnergyDecorator.cxx.

16 : AthReentrantAlgorithm(name, loc)

17 {}

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

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 75 of file AthCommonReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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, V, H > &	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, V, H > &	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, V, H > &	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, V, H > & 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 FlowEnergyDecorator::execute ( const EventContext & ctx ) const

overridevirtual

Definition at line 40 of file FlowEnergyDecorator.cxx.

                                                                      {
   ATH_MSG_DEBUG("Executing " << name() << "... ");
  
  
   SG::ReadHandle<xAOD::FlowElementContainer> pflowCont(m_PFlowContainerKey, ctx);
   if ( !pflowCont.isValid() ) {
     ATH_MSG_ERROR("Failed to retrieve " << m_PFlowContainerKey.key() << " !");
     return StatusCode::FAILURE;
   }
  
   SG::ReadHandle<xAOD::FlowElementContainer> ufoCont(m_FlowContainerKey, ctx);
   if ( !ufoCont.isValid() ) {
     ATH_MSG_ERROR("Failed to retrieve " << m_FlowContainerKey.key() << " !");
     return StatusCode::FAILURE;
   }
  
   // Declare the WriteDecorHandles for the total EM and HAD energies and fractions (no accessors needed here)
   SG::WriteDecorHandle<xAOD::FlowElementContainer, float> eEMDecorHandle(m_eEMKey, ctx);
   SG::WriteDecorHandle<xAOD::FlowElementContainer, float> eHADDecorHandle(m_eHADKey, ctx);
   SG::WriteDecorHandle<xAOD::FlowElementContainer, float> eFracEMDecorHandle(m_eFracEMKey, ctx);
   SG::WriteDecorHandle<xAOD::FlowElementContainer, float> eFracHADDecorHandle(m_eFracHADKey, ctx);
  
   // Declare the ReadDecorHandles and WriteDecorHandles for each EM layer energy accessor and decorator
   std::vector< SG::ReadDecorHandle<xAOD::FlowElementContainer, float> > layerAccessors_em;
   layerAccessors_em.reserve(m_emReadDecorKeys.size());
   for (const SG::ReadDecorHandleKey<xAOD::FlowElementContainer>& key: m_emReadDecorKeys) {
     layerAccessors_em.emplace_back(key, ctx);
   }
   std::vector< SG::WriteDecorHandle<xAOD::FlowElementContainer, float> > layerDecors_em;
   layerDecors_em.reserve(m_emWriteDecorKeys.size());
   for (const SG::WriteDecorHandleKey<xAOD::FlowElementContainer>& key: m_emWriteDecorKeys) {
     layerDecors_em.emplace_back(key, ctx);
   }
  
   // Declare the ReadDecorHandles and WriteDecorHandles for each HAD layer energy accessor and decorator
   std::vector< SG::ReadDecorHandle<xAOD::FlowElementContainer, float> > layerAccessors_had;
   layerAccessors_had.reserve(m_hadReadDecorKeys.size());
   for (const SG::ReadDecorHandleKey<xAOD::FlowElementContainer>& key: m_hadReadDecorKeys) {
     layerAccessors_had.emplace_back(key, ctx);
   }
   std::vector< SG::WriteDecorHandle<xAOD::FlowElementContainer, float> > layerDecors_had;
   layerDecors_em.reserve(m_hadWriteDecorKeys.size());
   for (const SG::WriteDecorHandleKey<xAOD::FlowElementContainer>& key: m_hadWriteDecorKeys) {
     layerDecors_had.emplace_back(key, ctx);
   }
  
   // loop over all UFOs from UFOCSSK
   for ( const xAOD::FlowElement* flow : *ufoCont ) {
     float eEM = 0.;
     float eHAD = 0.;
  
     // loop over all EM layers in the calorimeter
     for (size_t iem = 0; iem < m_emReadDecorKeys.size(); ++iem) {
  
       // declare references to the accessor and decorator for a given HAD layer
       const auto& layerAccessor = layerAccessors_em.at(iem);
       auto& layerDecor = layerDecors_em.at(iem);
  
       float e = 0.;
  
       // get the links to the pflow constituents of the UFO
       const std::vector<ElementLink<xAOD::IParticleContainer>>& pflowLinks = flow->otherObjectLinks();
       // loop over all available pflows of a given UFO
       for ( auto& el : pflowLinks ) {
         if ( !el.isValid() ) {throw std::runtime_error("Invalid ElementLink found.");};
         const xAOD::FlowElement* c = dynamic_cast<const xAOD::FlowElement*>(*el);
         if (not c) continue;
         if (c->charge() != 0) continue; // if the constituent is a track, continue
         e += layerAccessor(*c); // else the constituent is a cluster, so add the energy of every cluster for a given layer for the considered UFO
       }
       layerDecor(*flow) = e; // decorate the UFO with the energy associated to a given EM layer (once the energies from every cluster in this layer have been summed up)
       eEM += e;
     }
  
     // loop over all HAD layers in the calorimeter
     for (size_t ihad = 0; ihad < m_hadReadDecorKeys.size(); ++ihad) {
  
       // declare references to the accessor and decorator for a given HAD layer
       const auto& layerAccessor = layerAccessors_had.at(ihad);
       auto& layerDecor = layerDecors_had.at(ihad);
  
       float e = 0.;
  
       // get the links to the pflow constituents of the UFO
       const std::vector<ElementLink<xAOD::IParticleContainer>>& pflowLinks = flow->otherObjectLinks();
  
       // loop over all available pflows of a given UFO
       for ( auto& el : pflowLinks ) {
         if ( !el.isValid() ) {throw std::runtime_error("Invalid ElementLink found.");};
         const xAOD::FlowElement* c = static_cast<const xAOD::FlowElement*>(*el);
         if (c->charge() != 0) continue;
         e += layerAccessor(*c);
       }
       layerDecor(*flow) = e; // decorate the UFO with the energy associated to a given HAD layer (once the energies from every cluster in this layer have been summed up)
       eHAD += e;
     }
  
     // decorate the UFO with the total electromagnetic or hadronic energy once the loop over the layers is over for a given UFO
     eEMDecorHandle(*flow) = eEM;
     eHADDecorHandle(*flow) = eHAD;
  
     // decorate the UFO with the electromagnetic or hadronic energy fractions once the loop over the layers is over for a given UFO
     const float eTOT = eEM + eHAD;
     const bool eTotZero = close_to_zero(eTOT);
     eFracEMDecorHandle(*flow) = (!eTotZero) ? (eEM / eTOT) : 0.;
     eFracHADDecorHandle(*flow) = (!eTotZero) ? (eHAD / eTOT) : 0.;
   }
  
   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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

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

◆ initialize()

StatusCode FlowEnergyDecorator::initialize ( )

overridevirtual

Definition at line 19 of file FlowEnergyDecorator.cxx.

                                            {
   ATH_MSG_INFO("Initializing " << name() << "... ");
  
   ATH_CHECK(m_FlowContainerKey.initialize());
   ATH_CHECK(m_PFlowContainerKey.initialize());
  
   // Initialize the decorations keys for total EM and HAD energies and fractions
   ATH_CHECK(m_eEMKey.initialize());
   ATH_CHECK(m_eHADKey.initialize());
   ATH_CHECK(m_eFracEMKey.initialize());
   ATH_CHECK(m_eFracHADKey.initialize());
  
   // Initialize the layer energy accessors and decorators keys for both EM and HAD layers
   ATH_CHECK(m_emReadDecorKeys.initialize());
   ATH_CHECK(m_emWriteDecorKeys.initialize());
   ATH_CHECK(m_hadReadDecorKeys.initialize());
   ATH_CHECK(m_hadWriteDecorKeys.initialize());
  
   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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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_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_eEMKey

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> FlowEnergyDecorator::m_eEMKey

private

Initial value:

{
    this, "eEMDecorKey", m_FlowContainerKey, "eEM", "EM energy decoration"
  }

Definition at line 58 of file FlowEnergyDecorator.h.

◆ m_eFracEMKey

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> FlowEnergyDecorator::m_eFracEMKey

private

Initial value:

{
    this, "eFracEMDecorKey", m_FlowContainerKey, "eFracEM", "EM energy fraction decoration"
  }

Definition at line 66 of file FlowEnergyDecorator.h.

◆ m_eFracHADKey

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> FlowEnergyDecorator::m_eFracHADKey

private

Initial value:

{
    this, "eFracHADDecorKey", m_FlowContainerKey, "eFracHAD", "Hadronic energy fraction decoration"
  }

Definition at line 70 of file FlowEnergyDecorator.h.

◆ m_eHADKey

SG::WriteDecorHandleKey<xAOD::FlowElementContainer> FlowEnergyDecorator::m_eHADKey

private

Initial value:

{
    this, "eHADDecorKey", m_FlowContainerKey, "eHAD", "Hadronic energy decoration"
  }

Definition at line 62 of file FlowEnergyDecorator.h.

◆ m_emReadDecorKeys

SG::ReadDecorHandleKeyArray<xAOD::FlowElementContainer> FlowEnergyDecorator::m_emReadDecorKeys

private

Initial value:

{
    this, "LayerEnergyAccessorsEM", m_PFlowContainerKey, {}, "Layer EM  energy accessors"
  }

Definition at line 74 of file FlowEnergyDecorator.h.

◆ m_emWriteDecorKeys

SG::WriteDecorHandleKeyArray<xAOD::FlowElementContainer> FlowEnergyDecorator::m_emWriteDecorKeys

private

Initial value:

{
    this, "LayerEnergyDecoratorsEM", m_FlowContainerKey, {}, "Layer EM energy decoration"
  }

Definition at line 78 of file FlowEnergyDecorator.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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_FlowContainerKey

SG::ReadHandleKey<xAOD::FlowElementContainer> FlowEnergyDecorator::m_FlowContainerKey

private

Initial value:

{
    this, "UFOContainer", "UFOCSSK", "Key for the input flow collection"
  }

Definition at line 33 of file FlowEnergyDecorator.h.

◆ m_hadReadDecorKeys

SG::ReadDecorHandleKeyArray<xAOD::FlowElementContainer> FlowEnergyDecorator::m_hadReadDecorKeys

private

Initial value:

{
    this, "LayerEnergyAccessorsHAD", m_PFlowContainerKey, {}, "Layer Hadronic energy accessors"
  }

Definition at line 82 of file FlowEnergyDecorator.h.

◆ m_hadWriteDecorKeys

SG::WriteDecorHandleKeyArray<xAOD::FlowElementContainer> FlowEnergyDecorator::m_hadWriteDecorKeys

private

Initial value:

{
    this, "LayerEnergyDecoratorsHAD", m_FlowContainerKey, {}, "Layer Hadronic energy decoration"
  }

Definition at line 86 of file FlowEnergyDecorator.h.

◆ m_PFlowContainerKey

SG::ReadHandleKey<xAOD::FlowElementContainer> FlowEnergyDecorator::m_PFlowContainerKey

private

Initial value:

{
    this, "PFlowContainer", "GlobalNeutralParticleFlowObjects", "Key for the input pflow collection"
  }

Definition at line 38 of file FlowEnergyDecorator.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

Constructor & Destructor Documentation

◆ FlowEnergyDecorator()

Member Function Documentation

◆ 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_detStore

◆ m_eEMKey

◆ m_eFracEMKey

◆ m_eFracHADKey

◆ m_eHADKey

◆ m_emReadDecorKeys

◆ m_emWriteDecorKeys

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_FlowContainerKey

◆ m_hadReadDecorKeys

◆ m_hadWriteDecorKeys

◆ m_PFlowContainerKey

◆ m_varHandleArraysDeclared

◆ m_vhka