CaloCoolIdTool Class Reference

#include <CaloCoolIdTool.h>

Inheritance diagram for CaloCoolIdTool:

Collaboration diagram for CaloCoolIdTool:

Public Member Functions
	CaloCoolIdTool (const std::string &type, const std::string &name, const IInterface *parent)
	Ctor.
virtual	~CaloCoolIdTool ()
	Dtor.
StatusCode	initialize ()
	Initializes the tool.
unsigned int	getCoolChannelId (unsigned int cellHash, unsigned int &subHash) const
	Returns the cool channel id and subHash for a given calorimter cell.
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 ()
	Returns the tool's InterfaceID.

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
const CaloCell_ID *	m_calo_id
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 26 of file CaloCoolIdTool.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

CaloCoolIdTool()

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

Ctor.

Definition at line 13 of file CaloCoolIdTool.cxx.

                                             : 
  AthAlgTool(type, name, parent),
  m_calo_id(nullptr)
{
declareInterface<ICaloCoolIdTool>( this ); 
}

~CaloCoolIdTool()

CaloCoolIdTool::~CaloCoolIdTool ( )

virtualdefault

Dtor.

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

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

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

getCoolChannelId()

unsigned int CaloCoolIdTool::getCoolChannelId ( unsigned int cellHash, unsigned int & subHash ) const

virtual

Returns the cool channel id and subHash for a given calorimter cell.

Parameters

cellHash	Calorimeter cell hash
subHash	The "channel" number of the cell in the CaloCondBlob

Implements ICaloCoolIdTool.

Definition at line 44 of file CaloCoolIdTool.cxx.

{
  int subCalo(0);
  subHash = m_calo_id->subcalo_cell_hash(cellHash, subCalo);
  //std::cout << "Starting with hash=" << cellHash << ", SubCalo=" << subCalo << " subHash=" << subHash << std::endl;
  //=== EM calo
  if (subCalo==CaloCell_ID::LAREM) {
    //Sub-Calo hash gymastics to get sub-sub-calo hash (EMECA, EMBA, EMBC EMEC) 
    //(faster than converting hash to identfier and dealing with identifier)
    //Here are the magic numbers:
    // Hash order in LAREMCAL: 
    //Calo           Offset     
    //EMEC NEG       0              
    //EMB NEG        31872
    //EMB POS        31872 + 54784 = 86656
    //EMEC POS       31872 + 54784 + 54784 =141440
 
    if (subHash >= 141440) {
      subHash-=141440;
      return static_cast<unsigned int>(CaloCondUtils::EMECZPOS);
    }
    else if (subHash>=86656) {
      subHash-=86656;
      return static_cast<unsigned int>(CaloCondUtils::EMBZPOS);
    }
    else if (subHash>=31872) {
      subHash-=31872;
      return static_cast<unsigned int>(CaloCondUtils::EMBZNEG);
    }
    else
      return static_cast<unsigned int>(CaloCondUtils::EMECZNEG);
  }// end if LAr EM
  else if(subCalo==CaloCell_ID::LARHEC){  
    return static_cast<unsigned int>(CaloCondUtils::HEC);
  }
  //=== FCAL
  else if(subCalo==CaloCell_ID::LARFCAL){
    return static_cast<unsigned int>(CaloCondUtils::FCAL);
  }
  //=== TILE
  else if(subCalo==CaloCell_ID::TILE) {
    return static_cast<unsigned int>(CaloCondUtils::TILE);
  }
  
  //=== we should never go here
 
  msg(MSG::ERROR) << "cellHash is neither LAr nor Tile, something is deeply wrong" << endmsg;
  std::abort();
}

initialize()

StatusCode CaloCoolIdTool::initialize

(

)

Initializes the tool.

Definition at line 30 of file CaloCoolIdTool.cxx.

{
  StatusCode sc=detStore()->retrieve(m_calo_id,"CaloCell_ID");
  if (sc.isFailure()) {
    msg(MSG::ERROR) << "Failed to retrieve CaloCell_ID" << endmsg;
    return sc;
  }
 
  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.

interfaceID()

const InterfaceID & CaloCoolIdTool::interfaceID ( )

inlinestatic

Returns the tool's InterfaceID.

Definition at line 34 of file CaloCoolIdTool.h.

{return ICaloCoolIdTool::interfaceID();}

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_calo_id

const CaloCell_ID* CaloCoolIdTool::m_calo_id

private

Definition at line 46 of file CaloCoolIdTool.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_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:

• CaloCoolIdTool.h
• CaloCoolIdTool.cxx