Base class for tools to decode RPC raw data. More...

#include <RPC_RawDataProviderToolCore.h>

Inheritance diagram for Muon::RPC_RawDataProviderToolCore:

Collaboration diagram for Muon::RPC_RawDataProviderToolCore:

Public Member Functions
	RPC_RawDataProviderToolCore (const std::string &t, const std::string &n, const IInterface *p)
virtual	~RPC_RawDataProviderToolCore ()=default
virtual StatusCode	initialize () override
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
StatusCode	convertIntoContainers (const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vecRobs, const std::vector< IdentifierHash > &collections, RpcPadContainer pad, RpcSectorLogicContainer logic, const bool &decodeSL) const
std::vector< IdentifierHash >	to_be_converted (const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment &robFrag, const std::vector< IdentifierHash > &coll) 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
SG::ReadCondHandleKey< RpcCablingCondData >	m_readKey {this, "ReadKey", "RpcCablingCondData", "Key of RpcCablingCondData"}
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
ToolHandle< IRpcROD_Decoder >	m_decoder {this, "Decoder", "Muon::RpcROD_Decoder/RpcROD_Decoder"}
SG::WriteHandleKey< RpcPadContainer >	m_containerKey {this, "RdoLocation", "RPCPAD", "Name of the RPCPAD produced by RawDataProvider"}
SG::WriteHandleKey< RpcSectorLogicContainer >	m_sec

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

Base class for tools to decode RPC raw data.

This contains all the logic to decode a vector of ROB fragments into the relevent containers. The derived classes should do the management of the containers and then call the convertIntoContainers from the convert functions required by the interface.

Definition at line 27 of file RPC_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

◆ RPC_RawDataProviderToolCore()

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

Definition at line 11 of file RPC_RawDataProviderToolCore.cxx.

11 :

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

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Muon::RPC_RawDataProviderToolCore::m_robDataProvider

ServiceHandle< IROBDataProviderSvc > m_robDataProvider

Definition RPC_RawDataProviderToolCore.h:47

◆ ~RPC_RawDataProviderToolCore()

virtual Muon::RPC_RawDataProviderToolCore::~RPC_RawDataProviderToolCore ( )

virtualdefault

Member Function Documentation

◆ convertIntoContainers()

StatusCode Muon::RPC_RawDataProviderToolCore::convertIntoContainers	(	const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &	vecRobs,
		const std::vector< IdentifierHash > &	collections,
		RpcPadContainer *	pad,
		RpcSectorLogicContainer *	logic,
		const bool &	decodeSL ) const

protected

Definition at line 29 of file RPC_RawDataProviderToolCore.cxx.

                                                                                      {
    for (auto itFrag = vecRobs.begin(); itFrag != vecRobs.end(); itFrag++) {
        // convert only if data payload is delivered
        if ((**itFrag).rod_ndata() != 0) {
            std::vector<IdentifierHash> coll = to_be_converted(**itFrag, collections);
 
            if (m_decoder->fillCollections(**itFrag, *pad, coll, logic, decodeSL).isFailure()) {
                // store the error conditions into the StatusCode and continue
            }
        } else {
            if (msgLvl(MSG::DEBUG)) {
                uint32_t sourceId = (**itFrag).source_id();
                msg(MSG::DEBUG) << " ROB " << MSG::hex << sourceId << " is delivered with an empty payload" << MSG::dec << endmsg;
            }
            // store the error condition into the StatusCode and continue
        }
    }
 
    ATH_MSG_DEBUG("After processing, number of collections in container : " << pad->numberOfCollections());
 
    // in presence of errors return FAILURE
    // CALLGRIND_STOP_INSTRUMENTATION
    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

◆ initialize()

StatusCode Muon::RPC_RawDataProviderToolCore::initialize ( )

overridevirtual

Definition at line 14 of file RPC_RawDataProviderToolCore.cxx.

                                                       {
    // retrieve ROD decoder
    ATH_CHECK(m_decoder.retrieve());
 
    ATH_CHECK(m_containerKey.initialize());
    ATH_CHECK(m_sec.initialize());
 
    // get ROB data provider service
    ATH_CHECK(m_robDataProvider.retrieve());
 
    ATH_CHECK(m_readKey.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.

◆ to_be_converted()

std::vector< IdentifierHash > Muon::RPC_RawDataProviderToolCore::to_be_converted	(	const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment &	robFrag,
		const std::vector< IdentifierHash > &	coll ) const

protected

Definition at line 56 of file RPC_RawDataProviderToolCore.cxx.

                                                                                                                            {
    SG::ReadCondHandle<RpcCablingCondData> readHandle{m_readKey};
    const RpcCablingCondData* readCdo{*readHandle};
 
    std::vector<IdentifierHash> to_return;
    if (coll.empty()) {
        // get SubdetectorId and ModuleId
        uint32_t source_id = robFrag.rod_source_id();
        SourceIdentifier sid(source_id);
        to_return = (readCdo->rod2hash(sid.subdetector_id(), sid.module_id()));
    } else {
        uint32_t source_id = robFrag.rod_source_id();
        std::vector<IdentifierHash>::const_iterator it = coll.begin();
        to_return.reserve(coll.size());
        for (; it != coll.end(); ++it) {
            if (source_id == readCdo->hash2source(*it)) to_return.emplace_back(*it);
        }
    }
 
    return to_return;
}

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

SG::WriteHandleKey<RpcPadContainer> Muon::RPC_RawDataProviderToolCore::m_containerKey {this, "RdoLocation", "RPCPAD", "Name of the RPCPAD produced by RawDataProvider"}

protected

Definition at line 53 of file RPC_RawDataProviderToolCore.h.

53{this, "RdoLocation", "RPCPAD", "Name of the RPCPAD produced by RawDataProvider"};

◆ m_decoder

ToolHandle<IRpcROD_Decoder> Muon::RPC_RawDataProviderToolCore::m_decoder {this, "Decoder", "Muon::RpcROD_Decoder/RpcROD_Decoder"}

protected

Definition at line 50 of file RPC_RawDataProviderToolCore.h.

50{this, "Decoder", "Muon::RpcROD_Decoder/RpcROD_Decoder"};

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

SG::ReadCondHandleKey<RpcCablingCondData> Muon::RPC_RawDataProviderToolCore::m_readKey {this, "ReadKey", "RpcCablingCondData", "Key of RpcCablingCondData"}

protected

Definition at line 44 of file RPC_RawDataProviderToolCore.h.

44{this, "ReadKey", "RpcCablingCondData", "Key of RpcCablingCondData"};

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> Muon::RPC_RawDataProviderToolCore::m_robDataProvider

protected

Definition at line 47 of file RPC_RawDataProviderToolCore.h.

◆ m_sec

SG::WriteHandleKey<RpcSectorLogicContainer> Muon::RPC_RawDataProviderToolCore::m_sec

protected

Initial value:

{this, "RPCSec", "RPC_SECTORLOGIC",

"Name of the RPC_SECTORLOGIC produced by RawDataProvider"}

Definition at line 55 of file RPC_RawDataProviderToolCore.h.

55 {this, "RPCSec", "RPC_SECTORLOGIC",

56 "Name of the RPC_SECTORLOGIC produced by RawDataProvider"};

◆ 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

◆ RPC_RawDataProviderToolCore()

◆ ~RPC_RawDataProviderToolCore()

Member Function Documentation

◆ convertIntoContainers()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ to_be_converted()

◆ updateVHKA()

Member Data Documentation

◆ m_containerKey

◆ m_decoder

◆ m_detStore

◆ m_evtStore

◆ m_readKey

◆ m_robDataProvider

◆ m_sec

◆ m_varHandleArraysDeclared

◆ m_vhka