ROBDataProviderSvc provides access to individual ROB fragments. More...

#include <ROBDataProviderSvc.h>

Inheritance diagram for ROBDataProviderSvc:

Collaboration diagram for ROBDataProviderSvc:

Classes
struct	EventCache
	ROB fragment cache per slot. More...

Public Types
using	ROBF = OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment
	ROB Fragment class.

Public Member Functions
virtual StatusCode	initialize () override
	Initialize.
virtual void	setNextEvent (const EventContext &ctx, const RawEvent *re) override
	Add all ROBFragments of a RawEvent to cache.
virtual void	getROBData (const EventContext &ctx, const std::vector< uint32_t > &robIds, VROBFRAG &robFragments, const std::string_view callerName="UNKNOWN") override
	Retrieve ROBFragments for given ROB ids from cache.
virtual const RawEvent *	getEvent (const EventContext &ctx) override
	Retrieve the whole event.
virtual void	setEventStatus (const EventContext &ctx, uint32_t status) override
	Store the status for the event.
virtual uint32_t	getEventStatus (const EventContext &ctx) override
	Retrieve the status for the event.
virtual void	processCachedROBs (const EventContext &ctx, const std::function< void(const ROBF *)> &fn) const override

Private Member Functions
bool	filterRobWithStatus (const ROBF *rob)
	method to filter ROBs with given Status code

Private Attributes
SG::SlotSpecificObj< EventCache >	m_eventsCache
std::unordered_map< uint32_t, std::vector< uint32_t > >	m_filterRobMap
	map of full ROB Source ids and status words to be ignored for the ROB map
std::unordered_map< eformat::SubDetector, std::vector< uint32_t > >	m_filterSubDetMap
	map of Sub Det Source ids and status words to be ignored for the ROB map
Gaudi::Property< std::vector< std::pair< int, int > > >	m_filterRobWithStatus
Gaudi::Property< std::vector< std::pair< int, int > > >	m_filterSubDetWithStatus
Gaudi::Property< bool >	m_filterEmptyROB

Detailed Description

ROBDataProviderSvc provides access to individual ROB fragments.

Created: Sept 19, 2002 By: Hong Ma Modified: Aug. 18 2003 (common class for Online/Offline) By: Werner Wiedenmann Modified: Apr 21 2005 (remove dependency on data flow repository) By: Werner Wiedenmann Modified: Aug 2026 (major rewrite/cleanup for Phase-II) By: Frank Winklmeier

Definition at line 33 of file ROBDataProviderSvc.h.

Member Typedef Documentation

◆ ROBF

using ROBDataProviderSvc::ROBF = OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment

ROB Fragment class.

Definition at line 37 of file ROBDataProviderSvc.h.

Member Function Documentation

◆ filterRobWithStatus()

bool ROBDataProviderSvc::filterRobWithStatus ( const ROBF * rob )

private

method to filter ROBs with given Status code

Filter ROB with Sub Detector Id and Status Code.

Definition at line 232 of file ROBDataProviderSvc.cxx.

                                                            {
   // No filter criteria defined
   if (m_filterRobMap.empty() && m_filterSubDetMap.empty()) {
      return false;
   }
   // There should be at least one status element if there was an error
   // in case there are 0 status elements then there was no known error
   // (see event format document ATL-D-ES-0019 (EDMS))
   if (rob->nstatus() == 0) {
      return false;
   }
   // The ROB has at least one status element, access it via an iterator
   const uint32_t* rob_it_status;
   rob->status(rob_it_status);
 
   // Build the full ROB Sourceidentifier
   eformat::helper::SourceIdentifier src(rob->rob_source_id());
   // Check if there is a ROB specific filter rule defined for this ROB Id and match the status code
   if (auto it = m_filterRobMap.find(src.code()); it != m_filterRobMap.end()) {
      if (std::ranges::contains(it->second, *rob_it_status))
         return true;
   }
 
   // Check if there is a sub detector specific filter rule defined for this ROB Id and match the status code
   if (auto it = m_filterSubDetMap.find(src.subdetector_id()); it != m_filterSubDetMap.end()) {
      if (std::ranges::contains(it->second, *rob_it_status))
         return true;
   }
 
   return false;
}

◆ getEvent()

const RawEvent * ROBDataProviderSvc::getEvent ( const EventContext & ctx )

overridevirtual

Retrieve the whole event.

Definition at line 206 of file ROBDataProviderSvc.cxx.

                                                                      {
   return m_eventsCache.get(ctx)->event;
}

◆ getEventStatus()

uint32_t ROBDataProviderSvc::getEventStatus ( const EventContext & ctx )

overridevirtual

Retrieve the status for the event.

Definition at line 218 of file ROBDataProviderSvc.cxx.

                                                                     {
   return m_eventsCache.get(ctx)->eventStatus;
}

◆ getROBData()

void ROBDataProviderSvc::getROBData	(	const EventContext &	ctx,
		const std::vector< uint32_t > &	robIds,
		VROBFRAG &	robFragments,
		const std::string_view	callerName = "UNKNOWN" )

overridevirtual

Retrieve ROBFragments for given ROB ids from cache.

Return ROBData for ROB ids.

Definition at line 189 of file ROBDataProviderSvc.cxx.

                                                                                             {
 
   EventCache* cache = m_eventsCache.get(ctx);
 
   for (uint32_t id : ids) {
      const auto map_it = cache->robmap.find(id);
      if (map_it != cache->robmap.end()) {
         robFragments.push_back(map_it->second.get());
      } else {
        ATH_MSG_DEBUG("Failed to find ROB for id 0x" << MSG::hex << id << MSG::dec << ", Caller Name = " << callerName);
      }
   }
}

◆ initialize()

StatusCode ROBDataProviderSvc::initialize ( )

overridevirtual

Initialize.

Initialization.

Definition at line 92 of file ROBDataProviderSvc.cxx.

                                          {
   ATH_MSG_INFO("Initializing");
 
   for (const auto& [srcid, status] : m_filterRobWithStatus) {
      eformat::helper::SourceIdentifier src(srcid);
      if (src.human_detector() != "UNKNOWN") {
         m_filterRobMap[src.code()].push_back(status);
      }
   }
   for (const auto& [subdet, status] : m_filterSubDetWithStatus) {
      eformat::helper::SourceIdentifier src(static_cast<eformat::SubDetector>(subdet), 0);
      if (src.human_detector() != "UNKNOWN") {
         m_filterSubDetMap[src.subdetector_id()].push_back(status);
      }
   }
   ATH_MSG_INFO("---> Filter out empty ROB fragments = " << std::boolalpha << m_filterEmptyROB.value());
   ATH_MSG_INFO("---> Filter out specific ROBs by Status Code: # ROBs = " << m_filterRobMap.size());
 
   for (const auto& [id, status_vec] : m_filterRobMap) {
      eformat::helper::SourceIdentifier src(id);
      ATH_MSG_INFO("      RobId=0x" << MSG::hex << id << " -> in Sub Det = " << src.human_detector());
      for (uint32_t status : status_vec) {
         eformat::helper::Status tmpstatus(status);
         ATH_MSG_INFO("         Status Code=0x"
                      << MSG::hex << std::setfill( '0' ) << std::setw(8) << tmpstatus.code()
                      << " Generic Part=0x" << std::setw(4) << tmpstatus.generic()
                      << " Specific Part=0x" << std::setw(4) << tmpstatus.specific());
      }
   }
 
   ATH_MSG_INFO("---> Filter out Sub Detector ROBs by Status Code: # Sub Detectors = " <<
                m_filterSubDetMap.size());
 
   for (const auto& [det, status_vec] : m_filterSubDetMap) {
      eformat::helper::SourceIdentifier src(det, 0);
      ATH_MSG_INFO("      SubDetId=0x" << MSG::hex << det << " -> " << src.human_detector());
      for (uint32_t status : status_vec) {
         eformat::helper::Status tmpstatus(status);
         ATH_MSG_INFO("         Status Code=0x" <<
                      MSG::hex << std::setfill( '0' ) << std::setw(8) << tmpstatus.code() <<
                      " Generic Part=0x" << std::setw(4) << tmpstatus.generic() <<
                      " Specific Part=0x" << std::setw(4) << tmpstatus.specific());
      }
   }
   return StatusCode::SUCCESS;
}

◆ processCachedROBs()

void ROBDataProviderSvc::processCachedROBs	(	const EventContext &	ctx,
		const std::function< void(const ROBF *)> &	fn ) const

overridevirtual

Definition at line 223 of file ROBDataProviderSvc.cxx.

                                                                          {
   for ( const auto&  el : m_eventsCache.get(ctx)->robmap ) {
      fn( el.second.get() );
   }
}

◆ setEventStatus()

void ROBDataProviderSvc::setEventStatus	(	const EventContext &	ctx,
		uint32_t	status )

overridevirtual

Store the status for the event.

Set the status for the event.

Definition at line 212 of file ROBDataProviderSvc.cxx.

                                                                                {
   m_eventsCache.get(ctx)->eventStatus = status;
}

◆ setNextEvent()

void ROBDataProviderSvc::setNextEvent	(	const EventContext &	ctx,
		const RawEvent *	re )

overridevirtual

Add all ROBFragments of a RawEvent to cache.

Add a new RAW event and rebuild map.

Definition at line 141 of file ROBDataProviderSvc.cxx.

                                                                                   {
 
   EventCache* cache = m_eventsCache.get(ctx);
   // assign the event
   cache->event=re;
   // clear the old map
   cache->robmap.clear();
   // set the LVL1 id
   cache->currentLvl1ID = re->lvl1_id();
 
   // loop over all ROBs
   auto iter = re->child_iter();
   while (OFFLINE_FRAGMENTS_NAMESPACE::PointerType fp = iter.next()) {
      // create ROBFragment
      auto rob = std::make_unique<const ROBF>(fp);
      const uint32_t id = rob->source_id();
 
      if (filterRobWithStatus(rob.get())) {
         if (rob->nstatus() > 0) {
            const uint32_t* it_status;
            rob->status(it_status);
            eformat::helper::Status tmpstatus(*it_status);
            ATH_MSG_DEBUG("---> ROB Id = 0x" << MSG::hex << id << std::setfill('0') <<
                          " with Generic Status Code = 0x" << std::setw(4) << tmpstatus.generic() <<
                          " and Specific Status Code = 0x" << std::setw(4) << tmpstatus.specific() << MSG::dec <<
                          " removed for L1 Id = " << cache->currentLvl1ID);
         }
         rob.reset();
      } else if ((rob->rod_ndata() == 0) && m_filterEmptyROB) {
         ATH_MSG_DEBUG("---> Empty ROB Id = 0x" << MSG::hex << id << MSG::dec <<
                       " removed for L1 Id = " << cache->currentLvl1ID);
         rob.reset();
      } else {
         // add to the map, warn in case of overwrite
         const auto& [itr, new_entry] = cache->robmap.insert_or_assign(id, std::move(rob));
         if (!new_entry) {
            ATH_MSG_WARNING("ROBDataProviderSvc:: Duplicate ROBID 0x" << MSG::hex << id <<
                            " found. " << MSG::dec << "Overwriting the previous one.");
         }
      }
   }
   ATH_MSG_DEBUG("---> setNextEvent offline for " << name() <<
                 ", current LVL1 id = " << cache->currentLvl1ID <<
                 ", size of ROB cache = " << cache->robmap.size());
}

Member Data Documentation

◆ m_eventsCache

SG::SlotSpecificObj<EventCache> ROBDataProviderSvc::m_eventsCache

private

Definition at line 76 of file ROBDataProviderSvc.h.

◆ m_filterEmptyROB

Gaudi::Property<bool> ROBDataProviderSvc::m_filterEmptyROB

private

Initial value:

{

this, "filterEmptyROB", false, "Filter out empty ROB fragments"}

Definition at line 89 of file ROBDataProviderSvc.h.

89 {

90 this, "filterEmptyROB", false, "Filter out empty ROB fragments"};

◆ m_filterRobMap

std::unordered_map<uint32_t, std::vector<uint32_t> > ROBDataProviderSvc::m_filterRobMap

private

map of full ROB Source ids and status words to be ignored for the ROB map

Definition at line 79 of file ROBDataProviderSvc.h.

◆ m_filterRobWithStatus

Gaudi::Property<std::vector<std::pair<int, int> > > ROBDataProviderSvc::m_filterRobWithStatus

private

Initial value:

{

this, "filterRobWithStatus", {}, "ROB IDs and status words to filter (full ROB SourceID)"}

Definition at line 85 of file ROBDataProviderSvc.h.

85 {

86 this, "filterRobWithStatus", {}, "ROB IDs and status words to filter (full ROB SourceID)"};

◆ m_filterSubDetMap

std::unordered_map<eformat::SubDetector, std::vector<uint32_t> > ROBDataProviderSvc::m_filterSubDetMap

private

map of Sub Det Source ids and status words to be ignored for the ROB map

Definition at line 82 of file ROBDataProviderSvc.h.

◆ m_filterSubDetWithStatus

Gaudi::Property<std::vector<std::pair<int, int> > > ROBDataProviderSvc::m_filterSubDetWithStatus

private

Initial value:

{

this, "filterSubDetWithStatus", {}, "Sub-detector IDs and status words to filter"}

Definition at line 87 of file ROBDataProviderSvc.h.

87 {

88 this, "filterSubDetWithStatus", {}, "Sub-detector IDs and status words to filter"};

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ROBF

Member Function Documentation

◆ filterRobWithStatus()

◆ getEvent()

◆ getEventStatus()

◆ getROBData()

◆ initialize()

◆ processCachedROBs()

◆ setEventStatus()

◆ setNextEvent()

Member Data Documentation

◆ m_eventsCache

◆ m_filterEmptyROB

◆ m_filterRobMap

◆ m_filterRobWithStatus

◆ m_filterSubDetMap

◆ m_filterSubDetWithStatus