Tool doing the L1TopoRDO <-> ByteStream conversion. More...

#include <L1TopoByteStreamTool.h>

Inheritance diagram for L1TopoByteStreamTool:

Collaboration diagram for L1TopoByteStreamTool:

Public Member Functions
	L1TopoByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor. More...

virtual	~L1TopoByteStreamTool ()
	Default destructor. More...

virtual StatusCode	initialize ()
	Function to initialise the tool. More...

virtual StatusCode	finalize ()
	Function to finalise the tool. More...

const std::vector< uint32_t > &	sourceIDs ()
	return list of L1Topo ROD source IDs to use, defaults to DAQ ROD IDs More...

StatusCode	convert (const std::string &sgKey, L1TopoRDOCollection *result) const
	Convert ROBFragment to L1TopoRDO. More...

StatusCode	convert (const ROBF rob, L1TopoRDO &result) const
	Convert ROBFragment to L1TopoRDO. More...

StatusCode	convert (const L1TopoRDO result, RawEventWrite re) const
	convert L1TopoRDO to ByteStream 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 OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment	ROBF

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
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
L1TopoSrcIdMap *	m_srcIdMap
	Object to generate and convert between the various IDs of the L1Topo fragment. More...

std::vector< uint32_t >	m_sourceIDs
	Source IDs of L1Topo RODs. More...

BooleanProperty	m_doDAQROBs

BooleanProperty	m_doROIROBs

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

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 doing the L1TopoRDO <-> ByteStream conversion.

   The actual work of translating the information in a L1TopoRDO object
   into a L1Topo ROB fragment and vice-versa is done with this tool.
   Based on CTPByteStreamTool by David Berge.

See also: L1TopoByteStreamCnv

Author: Simon George

Date

Date: 2014-11-12 00:00:00

Definition at line 36 of file L1TopoByteStreamTool.h.

Member Typedef Documentation

◆ ROBF

typedef OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment L1TopoByteStreamTool::ROBF

private

Definition at line 38 of file L1TopoByteStreamTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ L1TopoByteStreamTool()

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

Default constructor.

The constructor takes care of correctly constructing the base class and declaring the tool's interface to the framework.

Definition at line 36 of file L1TopoByteStreamTool.cxx.

     : AthAlgTool(type, name, parent),
       m_srcIdMap(0),
       m_robDataProvider("ROBDataProviderSvc", "L1TopoByteStreamTool") {
   declareInterface<L1TopoByteStreamTool>(this);
   declareProperty("ROBSourceIDs", m_sourceIDs,
                   "ROB fragment source identifiers - overrides decodeDAQROBs "
                   "and decodeROIROBs");
   declareProperty(
       "decodeDAQROBs", m_doDAQROBs = true,
       "add standard DAQ ROBs to list of ROBs to decode; default true");
   declareProperty(
       "decodeROIROBs", m_doROIROBs = false,
       "add standard ROI ROBs to list of ROBs to decode; default false");
 }

◆ ~L1TopoByteStreamTool()

L1TopoByteStreamTool::~L1TopoByteStreamTool ( )

virtual

Default destructor.

The destructor doesn't need to do anything.

Definition at line 57 of file L1TopoByteStreamTool.cxx.

57 {}

Member Function Documentation

◆ convert() [1/3]

StatusCode L1TopoByteStreamTool::convert	(	const L1TopoRDO *	result,
		RawEventWrite *	re
	)		const

convert L1TopoRDO to ByteStream

Conversion from RDO to eformat::ROBFragment.

This is called from the L1TopoByteStreamCnv::createRep method.

Definition at line 130 of file L1TopoByteStreamTool.cxx.

                                                                  {
   ATH_MSG_DEBUG("executing convert() from RDO to ROBFragment");
  
   // Create Event Assembler
   FullEventAssembler<L1TopoSrcIdMap> fea;
  
   // Reset lumi-block number to 1
   fea.setDetEvtType(1);
   // Set L1Apos to center of readout window
   // uint16_t minorVersion = ( result->getNumberOfBunches() - 1u ) / 2u;
   // minorVersion &= ctpVersion.getL1APositionMask();
   // minorVersion <<= ctpVersion.getL1APositionShift();
   uint16_t minorVersion = 0;
   fea.setRodMinorVersion(minorVersion);
  
   FullEventAssembler<L1TopoSrcIdMap>::RODDATA* theROD;
  
   // Source ID of L1Topo
   // NB needs to change to using list of modules - as it is, it will just
   // produce one with an unconventional ID of 0x91000000.
   const uint32_t rodId = m_srcIdMap->getRodID();
   ATH_MSG_DEBUG(" ROD ID:" << MSG::hex << rodId);
   ATH_MSG_DEBUG(" ROD IDs:" << MSG::hex << m_sourceIDs << " NOT YET IMPLEMENTED");
  
   // get the ROD data container to be filled
   theROD = fea.getRodData(rodId);
  
   ATH_MSG_VERBOSE(" Dumping L1Topo data words:");
   // fill Data Words
   const std::vector<uint32_t>& vDataWords = result->getDataWords();
   std::vector<uint32_t>::const_iterator it = vDataWords.begin();
   std::vector<uint32_t>::const_iterator end = vDataWords.end();
   for (; it != end; ++it) {
     theROD->push_back(*it);
     ATH_MSG_VERBOSE("     0x" << MSG::hex << std::setw(8) << (*it));
   }
  
   // Now fill full event
   ATH_MSG_DEBUG("Now filling the event with the L1Topo fragment");
   fea.fill(re, msg());
  
   return StatusCode::SUCCESS;
 }

◆ convert() [2/3]

StatusCode L1TopoByteStreamTool::convert	(	const ROBF *	rob,
		L1TopoRDO *&	result
	)		const

Convert ROBFragment to L1TopoRDO.

Conversion from eformat::ROBFragment to RDO.

This is called from the L1TopoByteStreamCnv::createObj method.

Definition at line 209 of file L1TopoByteStreamTool.cxx.

                                                                                   {
   ATH_MSG_DEBUG("executing convert() from ROBFragment to RDO");
  
   uint32_t rodId = rob->rob_source_id();
  
   ATH_MSG_DEBUG("expected ROD sub-detector ID: " << MSG::hex << m_sourceIDs
                                                  << " ID found: " << MSG::hex
                                                  << rodId << MSG::dec);
  
   bool idMatch = false;
   for (auto id : m_sourceIDs) {
     if (rodId == id) {
       idMatch = true;
     }
   }
   if (idMatch) {
     // Need to check S-link trailer for errors - this would be propagated to
     // status word, see below.
     // First use ROB & ROD error check methods
     bool error_rob(false);
     bool error_rod(false);
     try {
       if (rob->check_rob()) {
         ATH_MSG_VERBOSE("ROB fragment checked ok");
       }
     } catch (std::exception const& ex) {
       ATH_MSG_WARNING("ROB fragment not valid: " << ex.what());
       error_rob = true;
     }
     try {
       if (rob->check_rod()) {
         ATH_MSG_VERBOSE("ROD fragment checked ok");
       }
     } catch (std::exception const& ex) {
       ATH_MSG_WARNING("ROD fragment not valid: " << ex.what());
       error_rod = true;
     }
  
     // Print some header info
     ATH_MSG_VERBOSE(
         MSG::hex << " \n"
                  << "  rod_version           0x" << rob->rod_version() << " \n"
                  << "  rod_run_no            0x" << MSG::dec
                  << rob->rod_run_no() << " \n"
                  << "  rod_lvl1_id           0x" << MSG::hex
                  << rob->rod_lvl1_id() << " \n"
                  << "  rod_bc_id             0x" << rob->rod_bc_id() << " \n"
                  << "  rod_lvl1_trigger_type 0x" << rob->rod_lvl1_trigger_type()
                  << " \n"
                  << "  nchildren             0x" << rob->nchildren() << " \n"
                  << MSG::dec);
  
     // print and check status words
     OFFLINE_FRAGMENTS_NAMESPACE::PointerType it_status = rob->rod_status();
     const uint32_t nstatus = rob->rod_nstatus();
     ATH_MSG_VERBOSE("Number of status words: " << nstatus);
     std::vector<uint32_t> vStatusWords;
     vStatusWords.reserve(nstatus);
     ATH_MSG_VERBOSE("Dumping ROD status words:");
     for (uint32_t i = 0; i < nstatus; ++i, ++it_status) {
       vStatusWords.push_back(static_cast<uint32_t>(*it_status));
       ATH_MSG_VERBOSE("     0x" << MSG::hex << std::setfill('0') << std::setw(8)
                                 << *it_status << MSG::dec);
     }
     // for definition of first status word see:
     // - bits 00-15: https://edms.cern.ch/document/445840/5.0a section 5.8
     // - bits 16-31: bits 16-31:
     // https://twiki.cern.ch/twiki/bin/viewauth/Atlas/ROBINFragmentErrors
     // Can do something more specific eventually.
     bool error_status(false);
     if (vStatusWords.size() == 0) {
       ATH_MSG_WARNING("ROD has no status word");
     }
     if (vStatusWords.size() > 0 && vStatusWords.at(0) != 0) {
       ATH_MSG_WARNING("Non-zero first status word, payload may not be valid");
       error_status = true;
     }
  
     // print and interpret data words and save them for RDO
     OFFLINE_FRAGMENTS_NAMESPACE::PointerType it_data = rob->rod_data();
     const uint32_t ndata = rob->rod_ndata();
     ATH_MSG_VERBOSE("Number of data words: " << ndata);
  
     ATH_MSG_VERBOSE("Dumping L1Topo data words:");
     std::vector<uint32_t> vDataWords;
     vDataWords.reserve(ndata);
     for (uint32_t i = 0; i < ndata; ++i, ++it_data) {
       vDataWords.push_back(static_cast<uint32_t>(*it_data));
       ATH_MSG_VERBOSE("     0x" << MSG::hex << std::setfill('0') << std::setw(8)
                                 << *it_data << MSG::dec);
     }
  
     // create L1Topo RDO
     result = new L1TopoRDO();
     result->setDataWords(std::move(vDataWords));
     result->setStatusWords(std::move(vStatusWords));
     if (error_status) {
       result->setError(L1Topo::Error::SLINK_STATUS_ERROR);
     }
     if (error_rob) {
       result->setError(L1Topo::Error::ROB_ERROR);
     }
     if (error_rod) {
       result->setError(L1Topo::Error::ROD_ERROR);
     }
     result->setSourceID(rodId);
  
     return StatusCode::SUCCESS;
   }
  
   ATH_MSG_ERROR("Wrong ROD ID found in the L1Topo ROB fragment!");
   return StatusCode::FAILURE;
 }

◆ convert() [3/3]

StatusCode L1TopoByteStreamTool::convert	(	const std::string &	sgKey,
		L1TopoRDOCollection *	result
	)		const

Convert ROBFragment to L1TopoRDO.

Definition at line 175 of file L1TopoByteStreamTool.cxx.

                                                                             {
   //
   // Get the ROB fragment:
   //
   IROBDataProviderSvc::VROBFRAG robFrags;
   m_robDataProvider->getROBData(Gaudi::Hive::currentContext(), m_sourceIDs, robFrags);
  
   if (robFrags.size() == 0) {
     ATH_MSG_WARNING("No ROB fragments found");
     return StatusCode::SUCCESS;
   }
  
   for (auto it : robFrags) {
     L1TopoRDO* rdo = nullptr;
     StatusCode sc = convert(ROBData(it).getROBFragment(), rdo);
     if (sc.isFailure()) {
       ATH_MSG_ERROR(" Failed to create Objects: " << sgKey);
       return sc;
     } else {
       result->push_back(rdo);  // append a copy of the pointer to the
                                // collection, i.e. takes ownership of the new
                                // L1TopoRDO.
     }
   }
   return StatusCode::SUCCESS;
 }

◆ 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 L1TopoByteStreamTool::finalize ( )

virtual

Function to finalise the tool.

The function deletes the L1TopoSrcIdMap object and finalises the base class.

Definition at line 85 of file L1TopoByteStreamTool.cxx.

                                           {
   delete m_srcIdMap;
   return AlgTool::finalize();
 }

◆ initialize()

StatusCode L1TopoByteStreamTool::initialize ( )

virtual

Function to initialise the tool.

The function creates a L1TopoSrcIdMap object that is used in the conversion and initialises the base class.

Definition at line 63 of file L1TopoByteStreamTool.cxx.

                                             {
   m_srcIdMap = new L1TopoSrcIdMap();
   ATH_MSG_DEBUG(m_sourceIDs);
   if (!m_sourceIDs.empty()) {
     ATH_MSG_INFO(
         "ROBSourceIDs property is set: this overrides decodeDAQROBs and "
         "decodeROIROBs");
   } else {
     m_sourceIDs = sourceIDs();
   }
   ATH_MSG_DEBUG(m_doDAQROBs);
   ATH_MSG_DEBUG(m_doROIROBs);
   ATH_MSG_DEBUG("using sourceIDs " << std::hex << std::showbase << m_sourceIDs
                                    << std::dec << std::noshowbase);
  
   CHECK(m_robDataProvider.retrieve());
   return AlgTool::initialize();
 }

◆ 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 & L1TopoByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

This function is needed by the framework to know what kind of tool this is.

Definition at line 28 of file L1TopoByteStreamTool.cxx.

                                                      {
   return IID_IL1TopoByteStreamTool;
 }

◆ 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 > & L1TopoByteStreamTool::sourceIDs ( )

return list of L1Topo ROD source IDs to use, defaults to DAQ ROD IDs

Return list of L1Topo source IDs to use for conversion.

By default the list of DAQ IDs are generated Will generate list according to algorithm herein, if not already provided via properties. Used by L1TopoByteStreamCnv and L1TopoByteStreamTool. The boolean properties decodeDAQROBs and decodeROIROBs are used to determine which ROB source IDs are added to the list.

Definition at line 100 of file L1TopoByteStreamTool.cxx.

                                                            {
   if (m_sourceIDs.empty()) {
     // iterate over link numbers: 0 is DAQ link, 1 is ROIB, 2 for New ROIB
     for (unsigned int slink : {0, 1, 2}) {
       unsigned int roiOrDaq = 0;
       if (slink > 0) {  // 0 means DAQ-type link, 1 means ROI-type link
         roiOrDaq = 1;
       }
       if (roiOrDaq == 0 && !m_doDAQROBs) {
         continue;  // skip DAQ ROBs
       } else if (roiOrDaq == 1 && !m_doROIROBs) {
         continue;  // skip ROI ROBs
       }
       for (unsigned int module :
          {0, 1}) {  // could be upgraded to 3 modules eventually?
         const uint32_t moduleId =
             L1Topo::ModuleID(slink, module, roiOrDaq).id();
         eformat::helper::SourceIdentifier sourceId(eformat::TDAQ_CALO_TOPO_PROC, moduleId);
     
         m_sourceIDs.push_back(sourceId.code());
       }
     }
   }
   return m_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_doDAQROBs

BooleanProperty L1TopoByteStreamTool::m_doDAQROBs

private

Definition at line 71 of file L1TopoByteStreamTool.h.

◆ m_doROIROBs

BooleanProperty L1TopoByteStreamTool::m_doROIROBs

private

Definition at line 72 of file L1TopoByteStreamTool.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> L1TopoByteStreamTool::m_robDataProvider

private

Service for reading bytestream.

Definition at line 76 of file L1TopoByteStreamTool.h.

◆ m_sourceIDs

std::vector<uint32_t> L1TopoByteStreamTool::m_sourceIDs

private

Source IDs of L1Topo RODs.

Definition at line 69 of file L1TopoByteStreamTool.h.

◆ m_srcIdMap

L1TopoSrcIdMap* L1TopoByteStreamTool::m_srcIdMap

private

Object to generate and convert between the various IDs of the L1Topo fragment.

Definition at line 67 of file L1TopoByteStreamTool.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

◆ ROBF

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ L1TopoByteStreamTool()

◆ ~L1TopoByteStreamTool()

Member Function Documentation

◆ convert() [1/3]

◆ convert() [2/3]

◆ convert() [3/3]

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

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sourceIDs()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_doDAQROBs

◆ m_doROIROBs

◆ m_evtStore

◆ m_robDataProvider

◆ m_sourceIDs

◆ m_srcIdMap

◆ m_varHandleArraysDeclared

◆ m_vhka