Tool to perform ROB fragments to ROD Header conversions. More...

#include <RodHeaderByteStreamTool.h>

Inheritance diagram for LVL1BS::RodHeaderByteStreamTool:

Collaboration diagram for LVL1BS::RodHeaderByteStreamTool:

Public Member Functions
	RodHeaderByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~RodHeaderByteStreamTool ()

virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

StatusCode	convert (const std::string &name, DataVector< LVL1::RODHeader > *rhCollection) const
	Convert ROB fragments to RODHeaders. More...

StatusCode	convert (const IROBDataProviderSvc::VROBFRAG &robFrags, DataVector< LVL1::RODHeader > *rhCollection) const

const std::vector< uint32_t > &	sourceIDs (const std::string &sgKey) const
	Return reference to vector with all possible Source Identifiers. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool InterfaceID. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef DataVector< LVL1::RODHeader >	RodHeaderCollection

typedef IROBDataProviderSvc::VROBFRAG::const_iterator	ROBIterator

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	ROBPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType	RODPointer

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::vector< uint32_t >	makeAllRobIds () const
	Fill vector with ROB IDs for given sub-detector. More...

std::vector< uint32_t >	makeRobIds (int numCrates, int crateOffset, const std::vector< int > &slinks, int daqOrRoi, eformat::SubDetector subdet, const std::vector< uint32_t > &prop) const

bool	isAppended (const std::string &sgKey, const std::string &flag) const
	Return true if StoreGate key ends in given string. More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
ServiceHandle< IROBDataProviderSvc >	m_robDataProvider
	Service for reading bytestream. More...

ToolHandle< LVL1BS::L1CaloErrorByteStreamTool >	m_errorTool
	Error collection tool. More...

std::vector< uint32_t >	m_sourceIDsProp
	ROB source IDs. More...

std::vector< uint32_t >	m_sourceIDsPPProp

std::vector< uint32_t >	m_sourceIDsCPProp

std::vector< uint32_t >	m_sourceIDsJEPProp

std::vector< uint32_t >	m_sourceIDsCPRoIProp

std::vector< uint32_t >	m_sourceIDsJEPRoIProp

std::vector< uint32_t >	m_sourceIDsCPRoIBProp

std::vector< uint32_t >	m_sourceIDsJEPRoIBProp

const L1CaloSrcIdMap	m_srcIdMap
	Source ID converter. More...

bool	m_useSWROD = false

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Tool to perform ROB fragments to ROD Header conversions.

Based on ROD document version 1_09h.

Author: Peter Faulkner

Definition at line 43 of file RodHeaderByteStreamTool.h.

Member Typedef Documentation

◆ ROBIterator

typedef IROBDataProviderSvc::VROBFRAG::const_iterator LVL1BS::RodHeaderByteStreamTool::ROBIterator

private

Definition at line 68 of file RodHeaderByteStreamTool.h.

◆ ROBPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::RodHeaderByteStreamTool::ROBPointer

private

Definition at line 69 of file RodHeaderByteStreamTool.h.

◆ RodHeaderCollection

typedef DataVector<LVL1::RODHeader> LVL1BS::RodHeaderByteStreamTool::RodHeaderCollection

private

Definition at line 67 of file RodHeaderByteStreamTool.h.

◆ RODPointer

typedef OFFLINE_FRAGMENTS_NAMESPACE::PointerType LVL1BS::RodHeaderByteStreamTool::RODPointer

private

Definition at line 70 of file RodHeaderByteStreamTool.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ RodHeaderByteStreamTool()

LVL1BS::RodHeaderByteStreamTool::RodHeaderByteStreamTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 46 of file RodHeaderByteStreamTool.cxx.

   : AthAlgTool(type, name, parent),
     m_robDataProvider("ROBDataProviderSvc", name),
     m_errorTool("LVL1BS::L1CaloErrorByteStreamTool/L1CaloErrorByteStreamTool")
 {
   declareInterface<RodHeaderByteStreamTool>(this);
  
   declareProperty("UseSWROD",m_useSWROD = false, "Use SWROD readout instead of legacy (which was removed in 2024)");
  
   declareProperty("ErrorTool", m_errorTool,
                   "Tool to collect errors for monitoring");
   declareProperty("ROBSourceIDs",        m_sourceIDsProp,
                   "ROB fragment source identifiers - All except RoIB");
   declareProperty("ROBSourceIDsPP",      m_sourceIDsPPProp,
                   "ROB fragment source identifiers - PP only");
   declareProperty("ROBSourceIDsCP",      m_sourceIDsCPProp,
                   "ROB fragment source identifiers - CP DAQ only");
   declareProperty("ROBSourceIDsJEP",     m_sourceIDsJEPProp,
                   "ROB fragment source identifiers - JEP DAQ only");
   declareProperty("ROBSourceIDsCPRoI",   m_sourceIDsCPRoIProp,
                   "ROB fragment source identifiers - CP RoI only");
   declareProperty("ROBSourceIDsJEPRoI",  m_sourceIDsJEPRoIProp,
                   "ROB fragment source identifiers - JEP RoI only");
   declareProperty("ROBSourceIDsCPRoIB",  m_sourceIDsCPRoIBProp,
                   "ROB fragment source identifiers - CP RoIB only");
   declareProperty("ROBSourceIDsJEPRoIB", m_sourceIDsJEPRoIBProp,
                   "ROB fragment source identifiers - JEP RoIB only");
 }

◆ ~RodHeaderByteStreamTool()

LVL1BS::RodHeaderByteStreamTool::~RodHeaderByteStreamTool ( )

virtual

Definition at line 79 of file RodHeaderByteStreamTool.cxx.

80 {

81 }

Member Function Documentation

◆ convert() [1/2]

StatusCode LVL1BS::RodHeaderByteStreamTool::convert	(	const IROBDataProviderSvc::VROBFRAG &	robFrags,
		DataVector< LVL1::RODHeader > *	rhCollection
	)		const

Definition at line 119 of file RodHeaderByteStreamTool.cxx.

 {
   const bool debug = msgLvl(MSG::DEBUG);
   if (debug) msg(MSG::DEBUG);
  
   // Loop over ROB fragments
  
   int robCount = 0;
   std::set<uint32_t> dupCheck;
   ROBIterator rob    = robFrags.begin();
   ROBIterator robEnd = robFrags.end();
   for (; rob != robEnd; ++rob) {
  
     if (debug) {
       ++robCount;
       msg() << "Treating ROB fragment " << robCount << endmsg;
     }
  
     // Skip fragments with ROB status errors
  
     uint32_t robid = (*rob)->source_id();
     if ((*rob)->nstatus() > 0) {
       ROBPointer robData;
       (*rob)->status(robData);
       if (*robData != 0) {
         m_errorTool->robError(robid, *robData);
         if (debug) msg() << "ROB status error - skipping fragment" << endmsg;
         continue;
       }
     }
  
     // Skip duplicate fragments
  
     if (!dupCheck.insert(robid).second) {
       m_errorTool->rodError(robid, L1CaloSubBlock::ERROR_DUPLICATE_ROB);
       if (debug) msg() << "Skipping duplicate ROB fragment" << endmsg;
       continue;
     }
  
     // Unpack ROD header info
  
     const uint32_t version  = (*rob)->rod_version();
     const uint32_t sourceId = (*rob)->rod_source_id();
     const uint32_t run      = (*rob)->rod_run_no();
     const uint32_t lvl1Id   = (*rob)->rod_lvl1_id();
     const uint32_t bcId     = (*rob)->rod_bc_id();
     const uint32_t trigType = (*rob)->rod_lvl1_trigger_type();
     const uint32_t detType  = (*rob)->rod_detev_type();
     const uint32_t nData    = (*rob)->rod_ndata();
  
     // Unpack status words
  
     std::vector<uint32_t> statusWords;
     unsigned int nstatus = (*rob)->rod_nstatus();
     if (nstatus <= 2) {
       RODPointer status;
       RODPointer statusEnd;
       (*rob)->rod_status(status);
       statusEnd = status + nstatus;
       for (; status != statusEnd; ++status) statusWords.push_back(*status);
     } else { // Likely corruption
       m_errorTool->rodError(robid, L1CaloSubBlock::ERROR_ROD_NSTATUS);
       continue;
     }
  
     // Save
  
     rhCollection->push_back(new LVL1::RODHeader(version, sourceId, run, lvl1Id,
                             bcId, trigType, detType, statusWords, nData));
     if (debug) {
       msg() << MSG::hex
             << "ROD Header version/sourceId/run/lvl1Id/bcId/trigType/detType/nData: "
             << version << "/" << sourceId << "/" << run << "/" << lvl1Id << "/"
             << bcId << "/" << trigType << "/" << detType << "/" << nData
             << endmsg << "ROD Status Words:";
       std::vector<uint32_t>::const_iterator pos  = statusWords.begin();
       std::vector<uint32_t>::const_iterator pose = statusWords.end();
       for (; pos != pose; ++pos) msg() << " " << *pos;
       msg() << MSG::dec << endmsg;
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ convert() [2/2]

StatusCode LVL1BS::RodHeaderByteStreamTool::convert	(	const std::string &	name,
		DataVector< LVL1::RODHeader > *	rhCollection
	)		const

Convert ROB fragments to RODHeaders.

Definition at line 107 of file RodHeaderByteStreamTool.cxx.

 {
   const std::vector<uint32_t>& vID(sourceIDs(sgKey));
   // // get ROB fragments
   IROBDataProviderSvc::VROBFRAG robFrags;
   m_robDataProvider->getROBData(Gaudi::Hive::currentContext(), vID, robFrags, "RodHeaderByteStreamTool");
   ATH_MSG_DEBUG("Number of ROB fragments:" << robFrags.size());
   return convert(robFrags, rhCollection);
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	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());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & 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; }

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ 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

◆ finalize()

StatusCode LVL1BS::RodHeaderByteStreamTool::finalize ( )

overridevirtual

Definition at line 99 of file RodHeaderByteStreamTool.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode LVL1BS::RodHeaderByteStreamTool::initialize ( )

overridevirtual

Definition at line 86 of file RodHeaderByteStreamTool.cxx.

 {
   ATH_MSG_INFO( "Initializing " << name() );
  
   m_srcIdMap.useSWROD(m_useSWROD);
  
   ATH_CHECK( m_errorTool.retrieve() );
  
   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.

◆ interfaceID()

const InterfaceID & LVL1BS::RodHeaderByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

Definition at line 39 of file RodHeaderByteStreamTool.cxx.

 {
   return IID_IRodHeaderByteStreamTool;
 }

◆ isAppended()

bool LVL1BS::RodHeaderByteStreamTool::isAppended	(	const std::string &	sgKey,
		const std::string &	flag
	)		const

private

Return true if StoreGate key ends in given string.

Definition at line 320 of file RodHeaderByteStreamTool.cxx.

 {
  
   return ::hasEnding(sgKey, flag) || ::hasEnding(sgKey, flag + "Aux.");
 }

◆ makeAllRobIds()

std::vector< uint32_t > LVL1BS::RodHeaderByteStreamTool::makeAllRobIds ( ) const

private

Fill vector with ROB IDs for given sub-detector.

Definition at line 274 of file RodHeaderByteStreamTool.cxx.

 {
   std::vector<uint32_t> robIds;
  
   auto append = [&robIds] (const std::vector<uint32_t>& v)
                 { robIds.insert (robIds.end(), v.begin(), v.end()); };
  
   append (sourceIDs ("PP"));
   append (sourceIDs ("CP"));
   append (sourceIDs ("CPRoI"));
   append (sourceIDs ("JEP"));
   append (sourceIDs ("JEPRoI"));
  
   // Don't include RoIBs (LVL2) in complete set
   return robIds;
 }

◆ makeRobIds()

std::vector< uint32_t > LVL1BS::RodHeaderByteStreamTool::makeRobIds	(	int	numCrates,
		int	crateOffset,
		const std::vector< int > &	slinks,
		int	daqOrRoi,
		eformat::SubDetector	subdet,
		const std::vector< uint32_t > &	prop
	)		const

private

Definition at line 292 of file RodHeaderByteStreamTool.cxx.

 {
   std::vector<uint32_t> robs;
  
   if (!prop.empty()) {
     robs = prop;
   }
   else {
     for (int crate = 0; crate < numCrates; ++crate) {
       const int numSlinks = slinks.size();
       for (int i = 0; i < numSlinks; ++i) {
         const uint32_t rodId = m_srcIdMap.getRodID(crate + crateOffset,
                                                     slinks[i], daqOrRoi, subdet);
         const uint32_t robId = m_srcIdMap.getRobID(rodId);
         robs.push_back (robId);
       }
     }
   }
   return robs;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ 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();
   }

◆ sourceIDs()

const std::vector< uint32_t > & LVL1BS::RodHeaderByteStreamTool::sourceIDs ( const std::string & sgKey ) const

Return reference to vector with all possible Source Identifiers.

Definition at line 208 of file RodHeaderByteStreamTool.cxx.

 {
   if (isAppended(sgKey, "PP")) {
     static const std::vector<int> slinksPP { 0, 1, 2, 3 };
     static const std::vector<uint32_t> sourceIDsPP =
       makeRobIds(8, 0, slinksPP, 0, eformat::TDAQ_CALO_PREPROC,
                  m_sourceIDsPPProp);
     return sourceIDsPP;
   }
  
   if (isAppended(sgKey, "CP")) {
     static const std::vector<int> slinksCP { 0, 2 };
     static const std::vector<uint32_t> sourceIDsCP =
       makeRobIds(4, 8, slinksCP, 0, eformat::TDAQ_CALO_CLUSTER_PROC_DAQ,
                  m_sourceIDsCPProp);
     return sourceIDsCP;
   }
  
   if (isAppended(sgKey, "CPRoI")) {
     static const std::vector<int> slinksCPRoI { 0 };
     static const std::vector<uint32_t> sourceIDsCPRoI =
       makeRobIds(4, 8, slinksCPRoI, 1, eformat::TDAQ_CALO_CLUSTER_PROC_ROI,
                  m_sourceIDsCPRoIProp);
     return sourceIDsCPRoI;
   }
  
   if (isAppended(sgKey, "JEP")) {
     static const std::vector<int> slinksJEP { 0, 1, 2, 3 };
     static const std::vector<uint32_t> sourceIDsJEP =
       makeRobIds(2, 12, slinksJEP, 0, eformat::TDAQ_CALO_JET_PROC_DAQ,
                  m_sourceIDsJEPProp);
     return sourceIDsJEP;
   }
  
   if (isAppended(sgKey, "JEPRoI")) {
     static const std::vector<int> slinksJEPRoI { 0 };
     static const std::vector<uint32_t> sourceIDsJEPRoI =
       makeRobIds(2, 12, slinksJEPRoI, 1, eformat::TDAQ_CALO_JET_PROC_ROI,
                  m_sourceIDsJEPRoIProp);
     return sourceIDsJEPRoI;
   }
  
   if (isAppended(sgKey, "CPRoIB")) {
     static const std::vector<int> slinksCPRoIB { 2 };
     static const std::vector<uint32_t> sourceIDsCPRoIB =
       makeRobIds(4, 8, slinksCPRoIB, 1, eformat::TDAQ_CALO_CLUSTER_PROC_ROI,
                  m_sourceIDsCPRoIBProp);
     return sourceIDsCPRoIB;
   }
  
   if (isAppended(sgKey, "JEPRoIB")) {
     static const std::vector<int> slinksJEPRoIB { 2 };
     static const std::vector<uint32_t> sourceIDsJEPRoIB =
       makeRobIds(2, 12, slinksJEPRoIB, 1, eformat::TDAQ_CALO_JET_PROC_ROI,
                  m_sourceIDsJEPRoIBProp);
     return sourceIDsJEPRoIB;
   }
  
   // all
   static const std::vector<uint32_t> sourceIDs = makeAllRobIds();
   return sourceIDs;
 }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ 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_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_errorTool

ToolHandle<LVL1BS::L1CaloErrorByteStreamTool> LVL1BS::RodHeaderByteStreamTool::m_errorTool

private

Error collection tool.

Definition at line 86 of file RodHeaderByteStreamTool.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_robDataProvider

ServiceHandle<IROBDataProviderSvc> LVL1BS::RodHeaderByteStreamTool::m_robDataProvider

private

Service for reading bytestream.

Definition at line 84 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsCPProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsCPProp

private

Definition at line 91 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsCPRoIBProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsCPRoIBProp

private

Definition at line 95 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsCPRoIProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsCPRoIProp

private

Definition at line 93 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsJEPProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsJEPProp

private

Definition at line 92 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsJEPRoIBProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsJEPRoIBProp

private

Definition at line 96 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsJEPRoIProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsJEPRoIProp

private

Definition at line 94 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsPPProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsPPProp

private

Definition at line 90 of file RodHeaderByteStreamTool.h.

◆ m_sourceIDsProp

std::vector<uint32_t> LVL1BS::RodHeaderByteStreamTool::m_sourceIDsProp

private

ROB source IDs.

Definition at line 89 of file RodHeaderByteStreamTool.h.

◆ m_srcIdMap

const L1CaloSrcIdMap LVL1BS::RodHeaderByteStreamTool::m_srcIdMap

private

Source ID converter.

Definition at line 98 of file RodHeaderByteStreamTool.h.

◆ m_useSWROD

bool LVL1BS::RodHeaderByteStreamTool::m_useSWROD = false

private

Definition at line 100 of file RodHeaderByteStreamTool.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ROBIterator

◆ ROBPointer

◆ RodHeaderCollection

◆ RODPointer

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ RodHeaderByteStreamTool()

◆ ~RodHeaderByteStreamTool()

Member Function Documentation

◆ convert() [1/2]

◆ convert() [2/2]

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ isAppended()

◆ makeAllRobIds()

◆ makeRobIds()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sourceIDs()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_errorTool

◆ m_evtStore

◆ m_robDataProvider

◆ m_sourceIDsCPProp

◆ m_sourceIDsCPRoIBProp

◆ m_sourceIDsCPRoIProp

◆ m_sourceIDsJEPProp

◆ m_sourceIDsJEPRoIBProp

◆ m_sourceIDsJEPRoIProp

◆ m_sourceIDsPPProp

◆ m_sourceIDsProp

◆ m_srcIdMap

◆ m_useSWROD

◆ m_varHandleArraysDeclared

◆ m_vhka