#include <CaloClusterSnapshot.h>

Inheritance diagram for CaloClusterSnapshot:

Collaboration diagram for CaloClusterSnapshot:

Public Member Functions
	CaloClusterSnapshot (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~CaloClusterSnapshot () override
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *) const override
	Execute on an entire collection of clusters.
virtual StatusCode	execute (xAOD::CaloClusterContainer *collection) final
	Execute on an entire collection of clusters.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
	DeclareInterfaceID (CaloClusterCollectionProcessor, 1, 0)

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

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>

Private Attributes
SG::WriteHandleKey< xAOD::CaloClusterContainer >	m_outputKey
SG::WriteHandleKey< CaloClusterCellLinkContainer >	m_cellLinkOutputKey
bool	m_setCrossLinks
std::string	m_finalContName
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 13 of file CaloClusterSnapshot.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CaloClusterSnapshot()

CaloClusterSnapshot::CaloClusterSnapshot	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 14 of file CaloClusterSnapshot.cxx.

                                            :
  AthAlgTool(type, name, parent),
  m_outputKey("")
{ 
  declareInterface<CaloClusterCollectionProcessor> (this);
  declareProperty("OutputName",m_outputKey);
  declareProperty("CellLinkName",m_cellLinkOutputKey);
  declareProperty("SetCrossLinks",m_setCrossLinks=false);
  declareProperty("FinalClusterContainerName", m_finalContName);
  
}

◆ ~CaloClusterSnapshot()

CaloClusterSnapshot::~CaloClusterSnapshot ( )

overridevirtualdefault

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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());
 
  }

◆ DeclareInterfaceID()

CaloClusterCollectionProcessor::DeclareInterfaceID	(	CaloClusterCollectionProcessor	,
		1	,
		0	)

inherited

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute() [1/2]

StatusCode CaloClusterSnapshot::execute	(	const EventContext &	ctx,
		xAOD::CaloClusterContainer *	collection ) const

overridevirtual

Execute on an entire collection of clusters.

Parameters

collection The container of clusters. param ctx The event context.

Implements CaloClusterCollectionProcessor.

Definition at line 46 of file CaloClusterSnapshot.cxx.

{
  ATH_MSG_DEBUG("Executing CaloClusterSnapshot");
  
  SG::WriteHandle<xAOD::CaloClusterContainer>  outputColl(m_outputKey, ctx);
  
  ATH_CHECK(CaloClusterStoreHelper::AddContainerWriteHandle(outputColl));
  
  CaloClusterStoreHelper::copyContainer(clusColl,outputColl.ptr());
 
  if (m_setCrossLinks) {
    const size_t nClusters=clusColl->size();
    if (nClusters!=outputColl->size()) {
      ATH_MSG_ERROR("After copy of container: Unequal number of entries! Original " << nClusters << ", copy " << outputColl->size());
      return StatusCode::FAILURE;
    }
 
    //final cluster to snapshot:
    using ClusterLink_t = ElementLink<xAOD::CaloClusterContainer>;
    ClusterLink_t outputEL (outputColl.name(), 0, ctx);
    for (size_t i=0;i<nClusters;++i) {
      (*clusColl)[i]->setSisterClusterLink(ClusterLink_t(outputEL, i));
    }
 
    //From snapshot to final cluster
    if (m_setCrossLinks) {
       ClusterLink_t finalEL (m_finalContName, 0, ctx);
       if (finalEL.isValid()) {
     for (size_t i=0;i<nClusters;++i) {
       (*outputColl)[i]->setSisterClusterLink(ClusterLink_t(finalEL, i));
       //    std::cout << "Setting link to " << m_finalContName << ", index "<< i <<std::endl;
     }
       }
       else {
     ATH_MSG_DEBUG("Can't set element link from snapshot to final cluster, likely mismatch in the FinalClusterContainerName");  
       }
    }
  }
 
  
  SG::WriteHandle<CaloClusterCellLinkContainer> cellLinks (m_cellLinkOutputKey, ctx);
  ATH_CHECK(CaloClusterStoreHelper::finalizeClusters (cellLinks,
                                                      outputColl.ptr()));
  
  return StatusCode::SUCCESS;
}

◆ execute() [2/2]

virtual StatusCode CaloClusterCollectionProcessor::execute ( xAOD::CaloClusterContainer * collection )

inlinefinalvirtual

Execute on an entire collection of clusters.

Parameters

collection The container of clusters. (deprecated)

Reimplemented from CaloClusterCollectionProcessor.

Definition at line 50 of file CaloClusterCollectionProcessor.h.

  {
    return execute (Gaudi::Hive::currentContext(), collection);
  }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ initialize()

StatusCode CaloClusterSnapshot::initialize ( )

overridevirtual

Definition at line 34 of file CaloClusterSnapshot.cxx.

                                           {
  ATH_CHECK(m_outputKey.initialize());
  if (m_cellLinkOutputKey.key().empty()) {
    m_cellLinkOutputKey = m_outputKey.key() + "_links";
  }
  ATH_CHECK(m_cellLinkOutputKey.initialize());
  return StatusCode::SUCCESS;
 
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_cellLinkOutputKey

SG::WriteHandleKey<CaloClusterCellLinkContainer> CaloClusterSnapshot::m_cellLinkOutputKey

private

Definition at line 30 of file CaloClusterSnapshot.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_finalContName

std::string CaloClusterSnapshot::m_finalContName

private

Definition at line 34 of file CaloClusterSnapshot.h.

◆ m_outputKey

SG::WriteHandleKey<xAOD::CaloClusterContainer> CaloClusterSnapshot::m_outputKey

private

Definition at line 29 of file CaloClusterSnapshot.h.

◆ m_setCrossLinks

bool CaloClusterSnapshot::m_setCrossLinks

private

Definition at line 32 of file CaloClusterSnapshot.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ CaloClusterSnapshot()

◆ ~CaloClusterSnapshot()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute() [1/2]

◆ execute() [2/2]

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cellLinkOutputKey

◆ m_detStore

◆ m_evtStore

◆ m_finalContName

◆ m_outputKey

◆ m_setCrossLinks

◆ m_varHandleArraysDeclared

◆ m_vhka