CaloBadChanTool Class Reference

#include <CaloBadChanTool.h>

Inheritance diagram for CaloBadChanTool:

Collaboration diagram for CaloBadChanTool:

Public Member Functions
	CaloBadChanTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~CaloBadChanTool () override
virtual StatusCode	initialize () override
virtual CaloBadChannel	caloStatus (const EventContext &ctx, Identifier id) const override
virtual CaloBadChannel	caloStatus (Identifier id) const
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
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::ReadCondHandleKey< LArBadChannelCont >	m_larBCKey
ToolHandle< ICaloBadChanTool >	m_tileBCT
const CaloCell_ID *	m_caloID
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 18 of file CaloBadChanTool.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

CaloBadChanTool()

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

Definition at line 9 of file CaloBadChanTool.cxx.

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

~CaloBadChanTool()

CaloBadChanTool::~CaloBadChanTool ( )

overridevirtualdefault

Member Function Documentation

caloStatus() [1/2]

CaloBadChannel CaloBadChanTool::caloStatus ( const EventContext & ctx, Identifier id ) const

overridevirtual

Implements ICaloBadChanTool.

Definition at line 44 of file CaloBadChanTool.cxx.

{
  if (m_tileBCT && m_caloID->is_tile(id)) {
    return m_tileBCT->caloStatus(ctx,id);
  } else if (m_caloID->is_lar(id)) {
    SG::ReadCondHandle<LArBadChannelCont> bch{ m_larBCKey, ctx };
    const LArBadChannelCont* bcCont{ *bch };
    if (bcCont) {
      CaloBadChannel::BitWord res = 0;
      LArBadChannel lbc = bcCont->offlineStatus(id);
 
      if (lbc.reallyNoisy() || lbc.sporadicBurstNoise()) {
        CaloBadChannel::setBit(CaloBadChannel::noisyBit, res);
      }
      if (lbc.deadReadout() || lbc.deadPhys()) {
        CaloBadChannel::setBit(CaloBadChannel::deadBit, res);
      } else if (!lbc.good()) {
        CaloBadChannel::setBit(CaloBadChannel::affectedBit, res);
      }
      return {res};
    } else {
      CaloBadChannel empty;
      return empty;
    }
  } else {
    CaloBadChannel empty;
    return empty;
  }
}

caloStatus() [2/2]

virtual CaloBadChannel ICaloBadChanTool::caloStatus ( Identifier id ) const

inlinevirtual

Reimplemented from ICaloBadChanTool.

Definition at line 23 of file ICaloBadChanTool.h.

  {
    return caloStatus(Gaudi::Hive::currentContext(), id);
  }

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

initialize()

StatusCode CaloBadChanTool::initialize ( )

overridevirtual

Definition at line 20 of file CaloBadChanTool.cxx.

{
  ATH_MSG_DEBUG ("in initialize()" );
 
  StatusCode sc=m_larBCKey.initialize();
  if (sc.isFailure()) {
    ATH_MSG_WARNING ( "Unable to initialize LAr bad channels key: no LAr bad channel info will be provided " );
  }
  else
    ATH_MSG_DEBUG ( "LAr bad channels key initialized" );
 
 
  sc=m_tileBCT.retrieve();
  if (sc.isFailure()) {
    ATH_MSG_WARNING ( "Unable to get TileBadChannelTool: no Tile bad channel info will be provided " );
  }
  else
    ATH_MSG_DEBUG ( "TileBadChannelTool retrieved" );
 
  ATH_CHECK( detStore()->retrieve(m_caloID, "CaloCell_ID") );
  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 & ICaloBadChanTool::interfaceID ( )

inlinestaticinherited

Definition at line 28 of file ICaloBadChanTool.h.

                                          { 
    static const InterfaceID id("ICaloBadChanTool", 1 , 0);
    return id; 
  }

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_caloID

const CaloCell_ID* CaloBadChanTool::m_caloID

private

Definition at line 44 of file CaloBadChanTool.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_larBCKey

SG::ReadCondHandleKey<LArBadChannelCont> CaloBadChanTool::m_larBCKey

private

Initial value:

{
    this,
    "LArBadChanKey",
    "LArBadChannel",
    "LAr bad channel SG key"
  }

Definition at line 34 of file CaloBadChanTool.h.

                                                   {
    this,
    "LArBadChanKey",
    "LArBadChannel",
    "LAr bad channel SG key"
  };

m_tileBCT

ToolHandle<ICaloBadChanTool> CaloBadChanTool::m_tileBCT

private

Initial value:

{ this,
                                          "TileBadChanTool",
                                          "TileBadChanTool",
                                          "Tile bad channel tool" }

Definition at line 40 of file CaloBadChanTool.h.

                                        { this,
                                          "TileBadChanTool",
                                          "TileBadChanTool",
                                          "Tile bad channel tool" };

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:

• CaloBadChanTool.h
• CaloBadChanTool.cxx