A tool to decode TGC ROB fragments into TGC RDO. More...

#include <TGC_RawDataProviderToolCore.h>

Inheritance diagram for Muon::TGC_RawDataProviderToolCore:

Collaboration diagram for Muon::TGC_RawDataProviderToolCore:

Public Member Functions
	TGC_RawDataProviderToolCore (const std::string &t, const std::string &n, const IInterface *p)
	Default constructor.
virtual	~TGC_RawDataProviderToolCore ()=default
	Default destructor.
virtual StatusCode	initialize ()
	Standard AlgTool method.
virtual StatusCode	convertIntoContainer (const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vecRobs, TgcRdoContainer &tgcRdoContainer) const
	Method that converts the ROBFragments into the passed container.
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

Protected Member Functions
std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * >	getROBData (const std::vector< IdentifierHash > &rdoIdhVect, const EventContext &ctx) const
	Function to get the ROB data from a vector of IdentifierHash.
const MuonTGC_CablingSvc *	getCabling () const
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
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
ToolHandle< ITGC_RodDecoder >	m_decoder {this,"Decoder","Muon::TGC_RodDecoderReadout/TGC_RodDecoderReadout"}
	Decoder for ROB fragment RDO conversion.
SG::WriteHandleKey< TgcRdoContainer >	m_rdoContainerKey { this, "RdoLocation", "TGCRDO", "Name of the TGCRDO produced by RawDataProvider"}
	RDO container key.
unsigned int	m_maxhashtoUse = 0U
TGC_Hid2RESrcID	m_hid2re
	ID converter.
CxxUtils::CachedPointer< const MuonTGC_CablingSvc >	m_cabling
	TGC cabling Svc.
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
	Rob Data Provider handle.

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

A tool to decode TGC ROB fragments into TGC RDO.

Author: Zvi Tarem zvi@c.nosp@m.alip.nosp@m.er.co.nosp@m..il; Mark Owen marko.nosp@m.wen@.nosp@m.cern..nosp@m.ch

Definition at line 31 of file TGC_RawDataProviderToolCore.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

◆ TGC_RawDataProviderToolCore()

Muon::TGC_RawDataProviderToolCore::TGC_RawDataProviderToolCore	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Default constructor.

Definition at line 12 of file TGC_RawDataProviderToolCore.cxx.

                                                     :
  AthAlgTool(t, n, p),
  m_robDataProvider("ROBDataProviderSvc",n) 
{
}

◆ ~TGC_RawDataProviderToolCore()

virtual Muon::TGC_RawDataProviderToolCore::~TGC_RawDataProviderToolCore ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ convertIntoContainer()

StatusCode Muon::TGC_RawDataProviderToolCore::convertIntoContainer	(	const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &	vecRobs,
		TgcRdoContainer &	tgcRdoContainer ) const

virtual

Method that converts the ROBFragments into the passed container.

Static variables are not thread safe

Definition at line 52 of file TGC_RawDataProviderToolCore.cxx.

{    
  static thread_local int DecodeErrCount = 0;
 
  // Update to range based loop
  for(const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment* fragment : vecRobs){
    if(m_decoder->fillCollection(*fragment, tgcRdoContainer).isFailure()) {
      if(DecodeErrCount < 100) {
        ATH_MSG_INFO( "Problem with TGC ByteStream Decoding!" );
        DecodeErrCount++;
      } 
      else if(100 == DecodeErrCount) {
        ATH_MSG_INFO( "Too many Problems with TGC Decoding messages. Turning message off." );
        DecodeErrCount++;
      }
    }
  }
  ATH_MSG_DEBUG("Size of TgcRdoContainer is " << tgcRdoContainer.size());
  return StatusCode::SUCCESS;
}

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

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

◆ 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

◆ getCabling()

const MuonTGC_CablingSvc * Muon::TGC_RawDataProviderToolCore::getCabling ( ) const

protected

Definition at line 75 of file TGC_RawDataProviderToolCore.cxx.

{
  const MuonTGC_CablingSvc* cabling = m_cabling.get();
  if (cabling) {
    return cabling;
  }
 
  ServiceHandle<MuonTGC_CablingSvc> TgcCabGet("MuonTGC_CablingSvc", name());
  if (TgcCabGet.retrieve().isFailure()) {
    ATH_MSG_FATAL( "Could not get MuonTGC_CablingSvc !" );
    return nullptr;
  }
 
  m_cabling.set(TgcCabGet.get());
  
  return m_cabling.get();
}

◆ getROBData()

std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > Muon::TGC_RawDataProviderToolCore::getROBData	(	const std::vector< IdentifierHash > &	rdoIdhVect,
		const EventContext &	ctx ) const

protected

Function to get the ROB data from a vector of IdentifierHash.

Definition at line 94 of file TGC_RawDataProviderToolCore.cxx.

{
  std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecOfRobf;
  const MuonTGC_CablingSvc* cabling = getCabling();
  if(!cabling) {
    ATH_MSG_ERROR("Could not get cabling, return empty vector of ROB fragments");
    return vecOfRobf;
  }
 
  IdContext tgcContext = m_idHelperSvc->tgcIdHelper().module_context();
  
  std::vector<uint32_t> robIds;
 
  unsigned int size = rdoIdhVect.size();
  for(unsigned int i=0; i<size; ++i) {
    Identifier Id;
    if(m_idHelperSvc->tgcIdHelper().get_id(rdoIdhVect[i], Id, &tgcContext)) {
      ATH_MSG_WARNING( "Unable to get TGC Identifier from collection hash id " );
      continue;
    }
    const Identifier tgcId = Id;
    uint32_t rodId = m_hid2re.getRodID(tgcId, cabling);
    uint32_t robId = m_hid2re.getRobID(rodId);
    std::vector<uint32_t>::iterator it_robId = std::find(robIds.begin(), robIds.end(), robId); 
    if(it_robId==robIds.end()) {
      robIds.push_back(robId);
    }
  }
  m_robDataProvider->getROBData(ctx, robIds, vecOfRobf);
  ATH_MSG_VERBOSE( "Number of ROB fragments " << vecOfRobf.size() );
  return vecOfRobf;
}

◆ initialize()

StatusCode Muon::TGC_RawDataProviderToolCore::initialize ( )

virtual

Standard AlgTool method.

Definition at line 23 of file TGC_RawDataProviderToolCore.cxx.

{
  ATH_CHECK(AthAlgTool::initialize());
  ATH_CHECK(m_idHelperSvc.retrieve());
 
  ATH_CHECK(m_decoder.retrieve());
  ATH_MSG_DEBUG( "Retrieved tool " << m_decoder );
 
  // Get ROBDataProviderSvc
  ATH_CHECK(m_robDataProvider.retrieve());
  ATH_MSG_DEBUG( "Retrieved service " << m_robDataProvider );
 
  m_maxhashtoUse = m_idHelperSvc->tgcIdHelper().module_hash_max();  
 
  ATH_CHECK(m_rdoContainerKey.initialize());
 
  //try to configure the cabling service
  if (!getCabling()) {
    // ??? Is deferred initialization still needed here?
    ATH_MSG_INFO( "TGCCablingServerSvc not yet configured; postpone TGCcabling initialization at first event. " );
  }
 
  m_hid2re.fillAllRobIds();
  
  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_cabling

CxxUtils::CachedPointer<const MuonTGC_CablingSvc> Muon::TGC_RawDataProviderToolCore::m_cabling

protected

TGC cabling Svc.

Definition at line 61 of file TGC_RawDataProviderToolCore.h.

◆ m_decoder

ToolHandle<ITGC_RodDecoder> Muon::TGC_RawDataProviderToolCore::m_decoder {this,"Decoder","Muon::TGC_RodDecoderReadout/TGC_RodDecoderReadout"}

protected

Decoder for ROB fragment RDO conversion.

Definition at line 52 of file TGC_RawDataProviderToolCore.h.

52{this,"Decoder","Muon::TGC_RodDecoderReadout/TGC_RodDecoderReadout"};

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

TGC_Hid2RESrcID Muon::TGC_RawDataProviderToolCore::m_hid2re

protected

ID converter.

Definition at line 59 of file TGC_RawDataProviderToolCore.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::TGC_RawDataProviderToolCore::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

protected

Definition at line 50 of file TGC_RawDataProviderToolCore.h.

50{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_maxhashtoUse

unsigned int Muon::TGC_RawDataProviderToolCore::m_maxhashtoUse = 0U

protected

Definition at line 56 of file TGC_RawDataProviderToolCore.h.

◆ m_rdoContainerKey

SG::WriteHandleKey<TgcRdoContainer> Muon::TGC_RawDataProviderToolCore::m_rdoContainerKey { this, "RdoLocation", "TGCRDO", "Name of the TGCRDO produced by RawDataProvider"}

protected

RDO container key.

Definition at line 54 of file TGC_RawDataProviderToolCore.h.

54{ this, "RdoLocation", "TGCRDO", "Name of the TGCRDO produced by RawDataProvider"}; //MT

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> Muon::TGC_RawDataProviderToolCore::m_robDataProvider

protected

Rob Data Provider handle.

Definition at line 63 of file TGC_RawDataProviderToolCore.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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TGC_RawDataProviderToolCore()

◆ ~TGC_RawDataProviderToolCore()

Member Function Documentation

◆ convertIntoContainer()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getCabling()

◆ getROBData()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cabling

◆ m_decoder

◆ m_detStore

◆ m_evtStore

◆ m_hid2re

◆ m_idHelperSvc

◆ m_maxhashtoUse

◆ m_rdoContainerKey

◆ m_robDataProvider

◆ m_varHandleArraysDeclared

◆ m_vhka