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

#include <TGC_RawDataProviderTool.h>

Inheritance diagram for Muon::TGC_RawDataProviderTool:

Collaboration diagram for Muon::TGC_RawDataProviderTool:

Public Member Functions
virtual	~TGC_RawDataProviderTool ()=default
	Default destructor.
virtual StatusCode	initialize () override
	Standard AlgTool method.
virtual StatusCode	convert (const ROBFragmentList &vecRobs) const override
	Old decoding method which uses IROBDataProviderSvc in TgcRdoToPrepDataTool.
virtual StatusCode	convert (const ROBFragmentList &vecRobs, const std::vector< IdentifierHash > &rdoIdhVect) const override
	Old decoding method which uses IROBDataProviderSvc in TgcRdoToPrepDataTool with IdentifierHash vector.
virtual StatusCode	convert () const override
	New decoding methods which do not use IROBDataProviderSvc in TgcRdoToPrepDataTool.
virtual StatusCode	convert (const std::vector< IdentifierHash > &rdoIdhVect) const override
	New decoding methods which do not use IROBDataProviderSvc in TgcRdoToPrepDataTool with ID Hash vector.
virtual StatusCode	convert (const ROBFragmentList &, const EventContext &) const override
	EventContext ones.
virtual StatusCode	convert (const ROBFragmentList &, const std::vector< IdentifierHash > &, const EventContext &) const override
virtual StatusCode	convert (const EventContext &) const override
virtual StatusCode	convert (const std::vector< IdentifierHash > &, const EventContext &) const override

Private Member Functions
StatusCode	convertIntoContainer (const std::vector< const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment * > &vecRobs, TgcRdoContainer &tgcRdoContainer, const EventContext &ctx) const
	Method that converts the ROBFragments into the passed container.
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.
virtual StatusCode	convert (const std::vector< uint32_t > &) const override
	convert from vector of ROB IDs is not available
virtual StatusCode	convert (const std::vector< uint32_t > &, const EventContext &) const override
	EventContext ones.

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc
ToolHandle< ITGC_RodDecoder >	m_decoder
	Decoder for ROB fragment RDO conversion.
SG::WriteHandleKey< TgcRdoContainer >	m_rdoContainerKey
	RDO container key.
unsigned int	m_maxhashtoUse = 0U
TGC_Hid2RESrcID	m_hid2re
	ID converter.
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
	Rob Data Provider handle.
SG::ReadCondHandleKey< Muon::TgcCablingMap >	m_cablingKey
SG::UpdateHandleKey< TgcRdo_Cache >	m_rdoContainerCacheKey

Detailed Description

A tool to decode TGC ROB fragments into TGC RDO.

This version is for athenaMT.

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 30 of file TGC_RawDataProviderTool.h.

Constructor & Destructor Documentation

◆ ~TGC_RawDataProviderTool()

virtual Muon::TGC_RawDataProviderTool::~TGC_RawDataProviderTool ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ convert() [1/10]

StatusCode Muon::TGC_RawDataProviderTool::convert ( ) const

overridevirtual

New decoding methods which do not use IROBDataProviderSvc in TgcRdoToPrepDataTool.

Definition at line 149 of file TGC_RawDataProviderTool.cxx.

                                                  {
    return convert(Gaudi::Hive::currentContext());
}

◆ convert() [2/10]

StatusCode Muon::TGC_RawDataProviderTool::convert ( const EventContext & ctx ) const

overridevirtual

Definition at line 153 of file TGC_RawDataProviderTool.cxx.

                                                                         {
    std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecOfRobf;
    const std::vector<uint32_t>& robIds = m_hid2re.allRobIds();
 
    m_robDataProvider->getROBData(ctx, robIds, vecOfRobf);
 
    return convert(vecOfRobf, ctx);
}

◆ convert() [3/10]

StatusCode Muon::TGC_RawDataProviderTool::convert	(	const ROBFragmentList &	vecRobs,
		const EventContext &	ctx ) const

overridevirtual

EventContext ones.

Definition at line 103 of file TGC_RawDataProviderTool.cxx.

                                                                           {
 
    SG::WriteHandle<TgcRdoContainer> rdoContainerHandle(m_rdoContainerKey, ctx);
 
    // Split the methods to have one where we use the cache and one where we
    // just setup the container
    const bool externalCacheRDO = !m_rdoContainerCacheKey.key().empty();
    if (!externalCacheRDO) {
        ATH_CHECK(rdoContainerHandle.record(
            std::make_unique<TgcRdoContainer>(m_maxhashtoUse)));
        ATH_MSG_DEBUG("Created TGC container");
    } else {
        SG::UpdateHandle<TgcRdo_Cache> update(m_rdoContainerCacheKey, ctx);
        ATH_CHECK(update.isValid());
        ATH_CHECK(rdoContainerHandle.record(
            std::make_unique<TgcRdoContainer>(update.ptr())));
        ATH_MSG_DEBUG("Created container using cache for "
                      << m_rdoContainerCacheKey.key());
    }
 
    TgcRdoContainer* rdoContainer = rdoContainerHandle.ptr();
 
    // this should never happen, but since we dereference the pointer, we should
    // check
    if (!rdoContainer) {
        ATH_MSG_ERROR("TGC RDO Container is null, cannot decode TGC data");
        return StatusCode::FAILURE;
    }
 
    return convertIntoContainer(vecRobs, *rdoContainer, ctx);
}

◆ convert() [4/10]

StatusCode Muon::TGC_RawDataProviderTool::convert	(	const ROBFragmentList &	vecRobs,
		const std::vector< IdentifierHash > &	,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 143 of file TGC_RawDataProviderTool.cxx.

                                   {
    return convert(vecRobs, ctx);
}

◆ convert() [5/10]

StatusCode Muon::TGC_RawDataProviderTool::convert ( const ROBFragmentList & vecRobs ) const

overridevirtual

Old decoding method which uses IROBDataProviderSvc in TgcRdoToPrepDataTool.

Definition at line 98 of file TGC_RawDataProviderTool.cxx.

                                          {
    return convert(vecRobs, Gaudi::Hive::currentContext());
}

◆ convert() [6/10]

StatusCode Muon::TGC_RawDataProviderTool::convert	(	const ROBFragmentList &	vecRobs,
		const std::vector< IdentifierHash > &	rdoIdhVect ) const

overridevirtual

Old decoding method which uses IROBDataProviderSvc in TgcRdoToPrepDataTool with IdentifierHash vector.

Definition at line 136 of file TGC_RawDataProviderTool.cxx.

                                                                            {
    // This function does not use the IdentifierHash so we pass to the
    // EventContext function which also does not use it
    return convert(vecRobs, Gaudi::Hive::currentContext());
}

◆ convert() [7/10]

StatusCode Muon::TGC_RawDataProviderTool::convert	(	const std::vector< IdentifierHash > &	rdoIdhVect,
		const EventContext &	ctx ) const

overridevirtual

Definition at line 167 of file TGC_RawDataProviderTool.cxx.

                                   {
    std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecOfRobf =
        getROBData(rdoIdhVect, ctx);
 
    return convert(vecOfRobf, rdoIdhVect, ctx);
}

◆ convert() [8/10]

StatusCode Muon::TGC_RawDataProviderTool::convert ( const std::vector< IdentifierHash > & rdoIdhVect ) const

overridevirtual

New decoding methods which do not use IROBDataProviderSvc in TgcRdoToPrepDataTool with ID Hash vector.

Definition at line 162 of file TGC_RawDataProviderTool.cxx.

                                                       {
    return convert(rdoIdhVect, Gaudi::Hive::currentContext());
}

◆ convert() [9/10]

virtual StatusCode Muon::TGC_RawDataProviderTool::convert ( const std::vector< uint32_t > & ) const

inlineoverrideprivatevirtual

convert from vector of ROB IDs is not available

Definition at line 103 of file TGC_RawDataProviderTool.h.

                                                                          {
        return StatusCode::FAILURE;
    }

◆ convert() [10/10]

virtual StatusCode Muon::TGC_RawDataProviderTool::convert	(	const std::vector< uint32_t > &	,
		const EventContext &	) const

inlineoverrideprivatevirtual

EventContext ones.

Definition at line 107 of file TGC_RawDataProviderTool.h.

                                                                   {
        return StatusCode::FAILURE;
    }

◆ convertIntoContainer()

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

private

Method that converts the ROBFragments into the passed container.

Static variables are not thread safe

Definition at line 31 of file TGC_RawDataProviderTool.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, ctx)
                .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;
}

◆ getROBData()

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

private

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

Definition at line 58 of file TGC_RawDataProviderTool.cxx.

                                   {
    std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*> vecOfRobf;
    const TgcCablingMap* cabling{};
    if (!SG::get(cabling, m_cablingKey, ctx).isSuccess()) {
        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_RawDataProviderTool::initialize ( )

overridevirtual

Standard AlgTool method.

Definition at line 9 of file TGC_RawDataProviderTool.cxx.

                                               {
    ATH_CHECK(m_idHelperSvc.retrieve());
 
    ATH_CHECK(m_decoder.retrieve());
 
    // Get ROBDataProviderSvc
    ATH_CHECK(m_robDataProvider.retrieve());
 
    m_maxhashtoUse = m_idHelperSvc->tgcIdHelper().module_hash_max();
 
    ATH_CHECK(m_rdoContainerKey.initialize());
 
    ATH_CHECK(m_cablingKey.initialize());
    m_hid2re.fillAllRobIds();
    // Initialise the container cache if available
    ATH_CHECK(m_rdoContainerCacheKey.initialize(
        !m_rdoContainerCacheKey.key().empty()));
 
    ATH_MSG_INFO("initialize() successful in " << name());
    return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_cablingKey

SG::ReadCondHandleKey<Muon::TgcCablingMap> Muon::TGC_RawDataProviderTool::m_cablingKey

private

Initial value:

{

this, "CablingKey", "MuonTgc_CablingMap"}

Definition at line 97 of file TGC_RawDataProviderTool.h.

97 {

98 this, "CablingKey", "MuonTgc_CablingMap"};

◆ m_decoder

ToolHandle<ITGC_RodDecoder> Muon::TGC_RawDataProviderTool::m_decoder

private

Initial value:

{

this, "Decoder", "Muon::TGC_RodDecoderReadout/TGC_RodDecoderReadout"}

Decoder for ROB fragment RDO conversion.

Definition at line 82 of file TGC_RawDataProviderTool.h.

82 {

83 this, "Decoder", "Muon::TGC_RodDecoderReadout/TGC_RodDecoderReadout"};

◆ m_hid2re

TGC_Hid2RESrcID Muon::TGC_RawDataProviderTool::m_hid2re

private

ID converter.

Definition at line 92 of file TGC_RawDataProviderTool.h.

◆ m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> Muon::TGC_RawDataProviderTool::m_idHelperSvc

private

Initial value:

{

this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

Definition at line 79 of file TGC_RawDataProviderTool.h.

79 {

80 this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

◆ m_maxhashtoUse

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

private

Definition at line 89 of file TGC_RawDataProviderTool.h.

◆ m_rdoContainerCacheKey

SG::UpdateHandleKey<TgcRdo_Cache> Muon::TGC_RawDataProviderTool::m_rdoContainerCacheKey

private

Initial value:

{

this, "TgcContainerCacheKey", ""}

Definition at line 100 of file TGC_RawDataProviderTool.h.

100 {

101 this, "TgcContainerCacheKey", ""};

◆ m_rdoContainerKey

SG::WriteHandleKey<TgcRdoContainer> Muon::TGC_RawDataProviderTool::m_rdoContainerKey

private

Initial value:

{
        this, "RdoLocation", "TGCRDO",
        "Name of the TGCRDO produced by RawDataProvider"}

RDO container key.

Definition at line 85 of file TGC_RawDataProviderTool.h.

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

◆ m_robDataProvider

ServiceHandle<IROBDataProviderSvc> Muon::TGC_RawDataProviderTool::m_robDataProvider

private

Initial value:

{

this, "ROBDataProviderSvc", "ROBDataProviderSvc"}

Rob Data Provider handle.

Definition at line 94 of file TGC_RawDataProviderTool.h.

94 {

95 this, "ROBDataProviderSvc", "ROBDataProviderSvc"};

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~TGC_RawDataProviderTool()

Member Function Documentation

◆ convert() [1/10]

◆ convert() [2/10]

◆ convert() [3/10]

◆ convert() [4/10]

◆ convert() [5/10]

◆ convert() [6/10]

◆ convert() [7/10]

◆ convert() [8/10]

◆ convert() [9/10]

◆ convert() [10/10]

◆ convertIntoContainer()

◆ getROBData()

◆ initialize()

Member Data Documentation

◆ m_cablingKey

◆ m_decoder

◆ m_hid2re

◆ m_idHelperSvc

◆ m_maxhashtoUse

◆ m_rdoContainerCacheKey

◆ m_rdoContainerKey

◆ m_robDataProvider