#include <ROBDataProviderSvc.h>

Inheritance diagram for ROBDataProviderSvc:

Collaboration diagram for ROBDataProviderSvc:

Classes
struct	EventCache

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

Public Member Functions
	ROBDataProviderSvc (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

virtual StatusCode	initialize () override
	initialize the service More...

virtual void	addROBData (const EventContext &context, const std::vector< uint32_t > &robIds, const std::string_view callerName="UNKNOWN") override
	Add ROBFragments to cache for given ROB ids, ROB fragments may be retrieved with DataCollector. More...

virtual void	setNextEvent (const EventContext &context, const std::vector< OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment > &result) override
	Add a given LVL1/LVL2 ROBFragment to cache. More...

virtual void	setNextEvent (const EventContext &context, const RawEvent *re) override
	Add all ROBFragments of a RawEvent to cache. More...

virtual void	getROBData (const EventContext &context, const std::vector< uint32_t > &robIds, VROBFRAG &robFragments, const std::string_view callerName="UNKNOWN") override
	Retrieve ROBFragments for given ROB ids from cache. More...

virtual const RawEvent *	getEvent (const EventContext &context) override
	Retrieve the whole event. More...

virtual void	setEventStatus (const EventContext &context, uint32_t status) override
	Store the status for the event. More...

virtual uint32_t	getEventStatus (const EventContext &context) override
	Retrieve the status for the event. More...

virtual void	processCachedROBs (const EventContext &context, const std::function< void(const ROBF *)> &fn) const override

virtual bool	isEventComplete (const EventContext &) const override

virtual int	collectCompleteEventData (const EventContext &, const std::string_view) override

Protected Types
using	ROBMAP = std::map< uint32_t, std::unique_ptr< const ROBF >, std::less< uint32_t > >
	vector of ROBFragment class More...

using	ArrayPairIntType = std::vector< std::pair< int, int > >
	Remaining attributes are for configuration vector of Source ids and status words to be ignored for the ROB map. More...

using	FilterRobMap = std::map< uint32_t, std::vector< uint32_t > >
	map of full ROB Source ids and status words to be ignored for the ROB map More...

using	FilterSubDetMap = std::map< eformat::SubDetector, std::vector< uint32_t > >
	map of Sub Det Source ids and status words to be ignored for the ROB map More...

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

Protected Attributes
SG::SlotSpecificObj< EventCache >	m_eventsCache

Gaudi::Property< ArrayPairIntType >	m_filterRobWithStatus

Gaudi::Property< ArrayPairIntType >	m_filterSubDetWithStatus

FilterRobMap	m_filterRobMap

FilterSubDetMap	m_filterSubDetMap

Gaudi::Property< bool >	m_filterEmptyROB {this, "filterEmptyROB", false, "Filter out empty ROB fragments"}
	Filter out empty ROB fragments which are send by the ROS. More...

bool	m_maskL2EFModuleID = false

Static Private Member Functions
static void	robmapClear (ROBMAP &toclear)

Detailed Description

Definition at line 38 of file ROBDataProviderSvc.h.

Member Typedef Documentation

◆ ArrayPairIntType

using ROBDataProviderSvc::ArrayPairIntType = std::vector<std::pair<int, int> >

protected

Remaining attributes are for configuration vector of Source ids and status words to be ignored for the ROB map.

Definition at line 96 of file ROBDataProviderSvc.h.

◆ FilterRobMap

using ROBDataProviderSvc::FilterRobMap = std::map<uint32_t, std::vector<uint32_t> >

protected

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

Definition at line 103 of file ROBDataProviderSvc.h.

◆ FilterSubDetMap

using ROBDataProviderSvc::FilterSubDetMap = std::map<eformat::SubDetector, std::vector<uint32_t> >

protected

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

Definition at line 106 of file ROBDataProviderSvc.h.

◆ ROBF

using ROBDataProviderSvc::ROBF = OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment

ROB Fragment class.

Definition at line 42 of file ROBDataProviderSvc.h.

◆ ROBMAP

using ROBDataProviderSvc::ROBMAP = std::map<uint32_t, std::unique_ptr<const ROBF>, std::less<uint32_t> >

protected

vector of ROBFragment class

map for all the ROB fragments

Definition at line 83 of file ROBDataProviderSvc.h.

Constructor & Destructor Documentation

◆ ROBDataProviderSvc()

ROBDataProviderSvc::ROBDataProviderSvc	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor.

Definition at line 87 of file ROBDataProviderSvc.cxx.

88 : base_class(name, svcloc) {}

Member Function Documentation

◆ addROBData()

void ROBDataProviderSvc::addROBData	(	const EventContext &	context,
		const std::vector< uint32_t > &	robIds,
		const std::string_view	callerName = `"UNKNOWN"`
	)

overridevirtual

Add ROBFragments to cache for given ROB ids, ROB fragments may be retrieved with DataCollector.

in offline only check that given ROB ids are in the map, issue an error if not

Definition at line 143 of file ROBDataProviderSvc.cxx.

                                                                                                                                    {
     EventCache* cache = m_eventsCache.get( context );
  
    // Copy missing ROB ids to vector with pthread allocator
    ATH_MSG_DEBUG(" ---> Number of ROB Id s requested : " << robIds.size() << ", Caller Name = " << callerName);
    // for offline running all requested ROBs should be found in cache
    // if not issue error
    for (uint32_t id : robIds) {
       // mask off the module ID for L2 and EF result for Run 1 data
       if ( (eformat::helper::SourceIdentifier(id).module_id() != 0) &&
        (eformat::helper::SourceIdentifier(id).subdetector_id() == eformat::TDAQ_LVL2) ) {
      id = eformat::helper::SourceIdentifier(eformat::helper::SourceIdentifier(id).subdetector_id(),0).code();
      // TB if it is inconsistent we should not continue like this?
      if ( !m_maskL2EFModuleID ) {
        ATH_MSG_ERROR("Inconsistent flag for masking L2/EF module IDs");
        m_maskL2EFModuleID=true;
      }
       } else if ( (eformat::helper::SourceIdentifier(id).module_id() != 0) && 
           (eformat::helper::SourceIdentifier(id).subdetector_id() == eformat::TDAQ_EVENT_FILTER) &&
           ( m_maskL2EFModuleID ) ) {
      id = eformat::helper::SourceIdentifier(eformat::helper::SourceIdentifier(id).subdetector_id(),0).code();
       }
       ROBMAP& robmap( cache->robmap );
       ROBMAP::iterator map_it = robmap.find(id) ;
       if (map_it != robmap.end()) {
          ATH_MSG_DEBUG(" ---> Found   ROB Id : 0x" << MSG::hex << (*map_it).second->source_id()
              << MSG::dec << " in cache");
       } else {
          ATH_MSG_DEBUG(" ---> ROB Id : 0x" << MSG::hex << id
              << MSG::dec << " not found in cache for running mode OFFLINE (method addROBData),");
      ATH_MSG_DEBUG("      Lvl1 id  = " << cache->currentLvl1ID);
     }
   }
   return;
 }

◆ collectCompleteEventData()

virtual int ROBDataProviderSvc::collectCompleteEventData	(	const EventContext &	,
		const std::string_view
	)

inlineoverridevirtual

Definition at line 76 of file ROBDataProviderSvc.h.

76 { return 0; }

◆ filterRobWithStatus()

bool ROBDataProviderSvc::filterRobWithStatus ( const ROBF * rob )

protected

method to filter ROBs with given Status code

filter ROB with Sub Detector Id and Status Code

Definition at line 348 of file ROBDataProviderSvc.cxx.

                                                             {
    // No filter criteria defined
    if ((m_filterRobMap.size() == 0) && (m_filterSubDetMap.size() == 0)) {
       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 tmpsrc(rob->rob_source_id());
    // Check if there is a ROB specific filter rule defined for this ROB Id and match the status code
    FilterRobMap::iterator map_it_rob = m_filterRobMap.find(tmpsrc.code());
    if (map_it_rob != m_filterRobMap.end()) {
       for (uint32_t status : map_it_rob->second) {
          if (*rob_it_status == status) {
             return(true);
          }
       }
    }
    // Check if there is a sub detector specific filter rule defined for this ROB Id and match the status code
    FilterSubDetMap::iterator map_it_subdet = m_filterSubDetMap.find(tmpsrc.subdetector_id());
    if (map_it_subdet != m_filterSubDetMap.end()) {
       for (uint32_t status : map_it_subdet->second) {
          if (*rob_it_status == status) {
             return(true);
          }
       }
    }
    return(false);
 }

◆ getEvent()

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

overridevirtual

Retrieve the whole event.

Definition at line 320 of file ROBDataProviderSvc.cxx.

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

◆ getEventStatus()

uint32_t ROBDataProviderSvc::getEventStatus ( const EventContext & context )

overridevirtual

Retrieve the status for the event.

Definition at line 333 of file ROBDataProviderSvc.cxx.

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

◆ getROBData()

void ROBDataProviderSvc::getROBData	(	const EventContext &	context,
		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 ROBID

Definition at line 276 of file ROBDataProviderSvc.cxx.

                                                      {
   EventCache* cache = m_eventsCache.get( context );
  
    for (uint32_t id : ids) {
       // mask off the module ID for L2 and EF result for Run 1 data
       if ( (eformat::helper::SourceIdentifier(id).module_id() != 0) &&
        (eformat::helper::SourceIdentifier(id).subdetector_id() == eformat::TDAQ_LVL2) ) {
      id = eformat::helper::SourceIdentifier(eformat::helper::SourceIdentifier(id).subdetector_id(),0).code();
      if (!m_maskL2EFModuleID) {
        ATH_MSG_ERROR("Inconsistent flag for masking L2/EF module IDs");
        m_maskL2EFModuleID=true;
      }
       } else if ( (eformat::helper::SourceIdentifier(id).module_id() != 0) && 
           (eformat::helper::SourceIdentifier(id).subdetector_id() == eformat::TDAQ_EVENT_FILTER) &&
           (m_maskL2EFModuleID) ) {
      id = eformat::helper::SourceIdentifier(eformat::helper::SourceIdentifier(id).subdetector_id(),0).code();
       }
       ROBMAP::iterator map_it = cache->robmap.find(id);
       if (map_it != cache->robmap.end()) {
          v.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);
 #ifndef NDEBUG
          int nrob = 0;
          ATH_MSG_VERBOSE(" --- Dump of ROB cache ids --- total size = " << cache->robmap.size());
          for (const auto& p : cache->robmap) {
         ++nrob;
         ATH_MSG_VERBOSE(" # = " << nrob << "  id = 0x" << MSG::hex << p.second->source_id() << MSG::dec);
          }
 #endif
       }
    }
    return;
 }

◆ initialize()

StatusCode ROBDataProviderSvc::initialize ( )

overridevirtual

initialize the service

Definition at line 92 of file ROBDataProviderSvc.cxx.

                                           {
    ATH_MSG_INFO("Initializing");
    m_eventsCache = SG::SlotSpecificObj<EventCache>( SG::getNSlots() );
    
    for (unsigned int i = 0; i < m_filterRobWithStatus.value().size(); i++) {
       eformat::helper::SourceIdentifier tmpsrc(m_filterRobWithStatus.value()[i].first);
       if (tmpsrc.human_detector() != "UNKNOWN") {
          m_filterRobMap[tmpsrc.code()].push_back(m_filterRobWithStatus.value()[i].second);
       }
    }
    for (unsigned int i = 0; i < m_filterSubDetWithStatus.value().size(); i++) {
       eformat::helper::SourceIdentifier tmpsrc((eformat::SubDetector)m_filterSubDetWithStatus.value()[i].first, 0);
       if (tmpsrc.human_detector() != "UNKNOWN") {
          m_filterSubDetMap[tmpsrc.subdetector_id()].push_back(m_filterSubDetWithStatus.value()[i].second);
       }
    }
    ATH_MSG_INFO(" ---> Filter out empty ROB fragments                               = " << m_filterEmptyROB);
    ATH_MSG_INFO(" ---> Filter out specific ROBs by Status Code: # ROBs = " << m_filterRobMap.size());
    for (const auto& p : m_filterRobMap) {
       eformat::helper::SourceIdentifier tmpsrc(p.first);
       ATH_MSG_INFO("      RobId=0x" << MSG::hex << p.first << " -> in Sub Det = " << tmpsrc.human_detector());
       for (uint32_t status : p.second) {
          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& p : m_filterSubDetMap) {
       eformat::helper::SourceIdentifier tmpsrc(p.first, 0);
       ATH_MSG_INFO("      SubDetId=0x" << MSG::hex << p.first << " -> " << tmpsrc.human_detector());
       for (uint32_t status : p.second) {
          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);
 }

◆ isEventComplete()

virtual bool ROBDataProviderSvc::isEventComplete ( const EventContext & ) const

inlineoverridevirtual

Definition at line 75 of file ROBDataProviderSvc.h.

75 { return true; }

◆ processCachedROBs()

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

overridevirtual

Definition at line 337 of file ROBDataProviderSvc.cxx.

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

◆ robmapClear()

void ROBDataProviderSvc::robmapClear ( ROBMAP & toclear )

staticprivate

clear ROB map

Definition at line 313 of file ROBDataProviderSvc.cxx.

                                                      {
    for (auto& it : toclear) {
      it.second.reset();  
   }
   toclear.clear();
 }

◆ setEventStatus()

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

overridevirtual

Store the status for the event.

Set the status for the event.

Definition at line 328 of file ROBDataProviderSvc.cxx.

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

◆ setNextEvent() [1/2]

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

overridevirtual

Add all ROBFragments of a RawEvent to cache.

add a new Raw event
rebuild the map

Definition at line 204 of file ROBDataProviderSvc.cxx.

                                                                                        {
   EventCache* cache = m_eventsCache.get( context );
   
    cache->event=re;
    // clear the old map
    robmapClear( cache->robmap );
    // set the LVL1 id
    cache->currentLvl1ID = re->lvl1_id();
    // set flag for masking L2/EF module ID, this is only necessary for the separate L2 and EF systems from Run 1 
    m_maskL2EFModuleID = (re->nlvl2_trigger_info() != 0);
  
    // get all the ROBFragments
    constexpr size_t MAX_ROBFRAGMENTS = 4096;
    std::vector<OFFLINE_FRAGMENTS_NAMESPACE::PointerType> robF(MAX_ROBFRAGMENTS);
    OFFLINE_FRAGMENTS_NAMESPACE::PointerType rePointer;
    re->start(rePointer);
    size_t robcount = re->children(robF.data(), MAX_ROBFRAGMENTS);
    if (robcount == MAX_ROBFRAGMENTS) {
       ATH_MSG_ERROR("ROB buffer overflow");
    }
    // loop over all ROBs
    for (size_t irob = 0; irob < robcount; irob++) {
       // add to the map
       //const ROBF* rob = new ROBF(robF[irob]);
       std::unique_ptr<const ROBF> rob=std::make_unique<const ROBF>(robF[irob]);
       uint32_t id =  rob->source_id();
       // mask off the module ID for L2 and EF result for Run 1 data
       if ( (eformat::helper::SourceIdentifier(id).module_id() != 0) &&
        (eformat::helper::SourceIdentifier(id).subdetector_id() == eformat::TDAQ_LVL2) ) {
      id = eformat::helper::SourceIdentifier(eformat::helper::SourceIdentifier(id).subdetector_id(),0).code();
      if (!m_maskL2EFModuleID) {
        ATH_MSG_ERROR("Inconsistent flag for masking L2/EF module IDs");
        m_maskL2EFModuleID=true;
      }
       } else if ( (eformat::helper::SourceIdentifier(id).module_id() != 0) && 
           (eformat::helper::SourceIdentifier(id).subdetector_id() == eformat::TDAQ_EVENT_FILTER) &&
           (m_maskL2EFModuleID) ) {
      id = eformat::helper::SourceIdentifier(eformat::helper::SourceIdentifier(id).subdetector_id(),0).code();
       }
       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.value())) {
          ATH_MSG_DEBUG( " ---> Empty ROB Id = 0x" << MSG::hex << id << MSG::dec
              << " removed for L1 Id = " << cache->currentLvl1ID);
           rob.reset();
       } else {
          ROBMAP::const_iterator it = cache->robmap.find(id);
          if (it != cache->robmap.end()) {
             ATH_MSG_WARNING(" ROBDataProviderSvc:: Duplicate ROBID 0x" << MSG::hex << id
                 << " found. " << MSG::dec << " Overwriting the previous one ");
          } 
          cache->robmap[id]=std::move(rob);
          
       }
    }
    ATH_MSG_DEBUG(" ---> setNextEvent offline for " << name() );
    ATH_MSG_DEBUG("      current LVL1 id   = " << cache->currentLvl1ID );
    ATH_MSG_DEBUG("      size of ROB cache = " << cache->robmap.size() );
    return;
 }

◆ setNextEvent() [2/2]

void ROBDataProviderSvc::setNextEvent	(	const EventContext &	context,
		const std::vector< OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment > &	result
	)

overridevirtual

Add a given LVL1/LVL2 ROBFragment to cache.

this is the online method to add the LVL1/LVL2 result
this version of ROBDataProviderSvc does not support it
this version is for offline use only

Definition at line 182 of file ROBDataProviderSvc.cxx.

                                                                                           { 
   // clear the old map
   // TB honestly, why do any action if this is FATAL mistake
   //  robmapClear( m_eventsCache.get(context)->robmap );
  
    // This method should never be used by offline
    ATH_MSG_FATAL(" +-----------------------------------------------------------------+ ");
    ATH_MSG_FATAL(" | The method ROBDataProviderSvc::setNextEvent(const ROBF* result) | ");
    ATH_MSG_FATAL(" |    is not implemented for this version of ROBDataProviderSvc    | ");
    ATH_MSG_FATAL(" |      Use the version from the HLT repository if you need it.    | ");
    ATH_MSG_FATAL(" +-----------------------------------------------------------------+ ");
    ATH_MSG_FATAL(" ---> The " << result.size() << " ROB fragments in the call will not be used.");
    return;
 }

Member Data Documentation

◆ m_eventsCache

SG::SlotSpecificObj<EventCache> ROBDataProviderSvc::m_eventsCache

protected

Definition at line 92 of file ROBDataProviderSvc.h.

◆ m_filterEmptyROB

Gaudi::Property<bool> ROBDataProviderSvc::m_filterEmptyROB {this, "filterEmptyROB", false, "Filter out empty ROB fragments"}

protected

Filter out empty ROB fragments which are send by the ROS.

Definition at line 112 of file ROBDataProviderSvc.h.

◆ m_filterRobMap

FilterRobMap ROBDataProviderSvc::m_filterRobMap

protected

Definition at line 104 of file ROBDataProviderSvc.h.

◆ m_filterRobWithStatus

Gaudi::Property<ArrayPairIntType> ROBDataProviderSvc::m_filterRobWithStatus

protected

Initial value:

{

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

Definition at line 97 of file ROBDataProviderSvc.h.

◆ m_filterSubDetMap

FilterSubDetMap ROBDataProviderSvc::m_filterSubDetMap

protected

Definition at line 107 of file ROBDataProviderSvc.h.

◆ m_filterSubDetWithStatus

Gaudi::Property<ArrayPairIntType> ROBDataProviderSvc::m_filterSubDetWithStatus

protected

Initial value:

{

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

Definition at line 99 of file ROBDataProviderSvc.h.

◆ m_maskL2EFModuleID

bool ROBDataProviderSvc::m_maskL2EFModuleID = false

protected

Definition at line 113 of file ROBDataProviderSvc.h.

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

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Member Typedef Documentation

◆ ArrayPairIntType

◆ FilterRobMap

◆ FilterSubDetMap

◆ ROBF

◆ ROBMAP

Constructor & Destructor Documentation

◆ ROBDataProviderSvc()

Member Function Documentation

◆ addROBData()

◆ collectCompleteEventData()

◆ filterRobWithStatus()

◆ getEvent()

◆ getEventStatus()

◆ getROBData()

◆ initialize()

◆ isEventComplete()

◆ processCachedROBs()

◆ robmapClear()

◆ setEventStatus()

◆ setNextEvent() [1/2]

◆ setNextEvent() [2/2]

Member Data Documentation

◆ m_eventsCache

◆ m_filterEmptyROB

◆ m_filterRobMap

◆ m_filterRobWithStatus

◆ m_filterSubDetMap

◆ m_filterSubDetWithStatus

◆ m_maskL2EFModuleID