CaloTowerBuilderToolBase Class Reference

#include <CaloTowerBuilderToolBase.h>

Inheritance diagram for CaloTowerBuilderToolBase:

Collaboration diagram for CaloTowerBuilderToolBase:

Public Member Functions
	CaloTowerBuilderToolBase (const std::string &name, const std::string &type, const IInterface *parent)
	AlgTool constructor.
virtual	~CaloTowerBuilderToolBase ()
virtual StatusCode initialize	ATLAS_NOT_THREAD_SAFE () override
	common initialization
virtual void	setTowerSeg (const CaloTowerSeg &theTowerSeg) override
virtual StatusCode	execute (const EventContext &ctx, CaloTowerContainer *theContainer, const CaloCellContainer *theCell=nullptr, const CaloTowerSeg::SubSeg *subseg=nullptr) const override=0
	Run tower building and add results to the tower container.
virtual StatusCode	execute (const EventContext &ctx, CaloTowerContainer *theContainer)=0
	Run tower building and add results to the tower container.
virtual StatusCode	initializeTool () override=0
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
const CaloTowerSeg &	towerSeg () const
	Return the tower segmentation.
const CaloCellContainer *	getCells () const
	Retrieve cells from StoreGate.
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.

Protected Attributes
SG::ReadHandleKey< CaloCellContainer >	m_cellContainerName
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager","CaloDetDescrManager"}

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
CaloTowerSeg	m_theTowerSeg
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 29 of file CaloTowerBuilderToolBase.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

CaloTowerBuilderToolBase()

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

AlgTool constructor.

Definition at line 14 of file CaloTowerBuilderToolBase.cxx.

  : AthAlgTool(name, type, parent)
  , m_cellContainerName("AllCalo")
{
 
  // common properties
  declareProperty("CellContainerName", m_cellContainerName);
  declareInterface<ICaloTowerBuilderToolBase>(this);
}

~CaloTowerBuilderToolBase()

CaloTowerBuilderToolBase::~CaloTowerBuilderToolBase ( )

virtualdefault

Member Function Documentation

ATLAS_NOT_THREAD_SAFE()

virtual StatusCode initialize CaloTowerBuilderToolBase::ATLAS_NOT_THREAD_SAFE ( )

overridevirtual

common initialization

Implements ICaloTowerBuilderToolBase.

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());
 
  }

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute() [1/2]

virtual StatusCode CaloTowerBuilderToolBase::execute ( const EventContext & ctx, CaloTowerContainer * theContainer )

pure virtual

Run tower building and add results to the tower container.

Parameters

ctx	The current event context.
theContainer	The tower container to fill.

If the segmentation hasn't been set, take it from the tower container. This is for use by converters.

Implemented in CaloTowerBuilderTool, and LArFCalTowerBuilderTool.

execute() [2/2]

virtual StatusCode CaloTowerBuilderToolBase::execute ( const EventContext & ctx, CaloTowerContainer * theContainer, const CaloCellContainer * theCell = nullptr, const CaloTowerSeg::SubSeg * subseg = nullptr ) const

overridepure virtual

Run tower building and add results to the tower container.

If a cell container is provided, use that; otherwise, fetch from SG (the key is given by a job property). If subseg is provided, then we do the building only within the rectangular region that it describes. The segmentation of the tower container must match the region over which we're running the tower building.

Parameters

ctx	The current event context.
theContainer	The tower container to fill.
theCell	The cell container to read. If null, we fetch from SG.
subseg	If provided, run tower building only within this window. The tower container segmentation must match.

Implements ICaloTowerBuilderToolBase.

Implemented in CaloTowerBuilderTool, and LArFCalTowerBuilderTool.

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

getCells()

const CaloCellContainer * CaloTowerBuilderToolBase::getCells ( ) const

protected

Retrieve cells from StoreGate.

Definition at line 59 of file CaloTowerBuilderToolBase.cxx.

{
  const CaloCellContainer* cells = nullptr;
  if (!m_cellContainerName.key().empty()) {
    cells = SG::get (m_cellContainerName);
    if (!cells) {
      ATH_MSG_WARNING("no CaloCellContainer with key <"
                      << m_cellContainerName.key() << "> found, skip tool!");
      
    }
  }
  return cells;
}

initializeTool()

virtual StatusCode CaloTowerBuilderToolBase::initializeTool ( )

overridepure virtual

Implements ICaloTowerBuilderToolBase.

Implemented in CaloTowerBuilderTool, and LArFCalTowerBuilderTool.

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.

interfaceID()

const InterfaceID & ICaloTowerBuilderToolBase::interfaceID ( )

inlinestaticinherited

Definition at line 70 of file ICaloTowerBuilderToolBase.h.

                                          {
    static const InterfaceID IID("ICaloTowerBuilderToolBase", 1 , 0);
    return IID;
  }

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();
  }

setTowerSeg()

void CaloTowerBuilderToolBase::setTowerSeg ( const CaloTowerSeg & theTowerSeg )

overridevirtual

Implements ICaloTowerBuilderToolBase.

Definition at line 37 of file CaloTowerBuilderToolBase.cxx.

                                                                          {
 
  ATH_MSG_DEBUG(" in CaloTowerBuilderToolBase::setTowerSeg ");
  m_theTowerSeg = theTowerSeg;
  ATH_MSG_DEBUG("   neta,nphi,etamin,etamax " << theTowerSeg.neta()
      << " " << theTowerSeg.nphi() << " " << theTowerSeg.etamin()
      << " " << theTowerSeg.etamax());
}

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.

towerSeg()

const CaloTowerSeg & CaloTowerBuilderToolBase::towerSeg ( ) const

protected

Return the tower segmentation.

Definition at line 50 of file CaloTowerBuilderToolBase.cxx.

{
  return m_theTowerSeg;
}

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_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> CaloTowerBuilderToolBase::m_caloMgrKey {this,"CaloDetDescrManager","CaloDetDescrManager"}

protected

Definition at line 95 of file CaloTowerBuilderToolBase.h.

{this,"CaloDetDescrManager","CaloDetDescrManager"};

m_cellContainerName

SG::ReadHandleKey<CaloCellContainer> CaloTowerBuilderToolBase::m_cellContainerName

protected

Definition at line 92 of file CaloTowerBuilderToolBase.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_theTowerSeg

CaloTowerSeg CaloTowerBuilderToolBase::m_theTowerSeg

private

Definition at line 99 of file CaloTowerBuilderToolBase.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:

• CaloTowerBuilderToolBase.h
• CaloTowerBuilderToolBase.cxx