L1TriggerByteStreamDecoderAlg Class Reference

Algorithm calling tools to convert L1 ByteStream into xAOD collections. More...

#include <L1TriggerByteStreamDecoderAlg.h>

Inheritance diagram for L1TriggerByteStreamDecoderAlg:

Collaboration diagram for L1TriggerByteStreamDecoderAlg:

Public Member Functions
	L1TriggerByteStreamDecoderAlg (const std::string &name, ISvcLocator *svcLoc)
	Standard constructor. More...
virtual StatusCode	initialize () override
virtual StatusCode	start () override
virtual StatusCode	finalize () override
virtual StatusCode	execute (const EventContext &eventContext) const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	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

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
enum	ROBCheckBehaviour {   ROBCheckBehaviour::Undefined =-1, ROBCheckBehaviour::None, ROBCheckBehaviour::Warning, ROBCheckBehaviour::Error,   ROBCheckBehaviour::Fatal }
	The behaviour for non-zero ROB status words. More...
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	filterRobs (const IROBDataProviderSvc::VROBFRAG &in, IROBDataProviderSvc::VROBFRAG &out, const std::vector< uint32_t > &ids, std::string_view toolName, const EventContext &eventContext) const
	Copy over ROBFragment pointers from in to out for ROBs with IDs from the ids list. More...
StatusCode	checkRobs (const IROBDataProviderSvc::VROBFRAG &robs, std::string_view toolName, const EventContext &eventContext) const
	Check ROB status word and report if different from zero. 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
ToolHandleArray< IL1TriggerByteStreamTool >	m_decoderTools
	Tool performing the decoding work. More...
ServiceHandle< IROBDataProviderSvc >	m_robDataProviderSvc
	ROBDataProvider service handle. More...
ToolHandle< GenericMonitoringTool >	m_monTool
	Monitoring tool to create online histograms. More...
SG::ReadHandleKey< ByteStreamMetadataContainer >	m_bsMetaDataContRHKey
	StoreGate key for the ByteStreamMetadata container to retrieve detector mask. More...
Gaudi::Property< std::vector< uint32_t > >	m_maybeMissingRobsProp
	Allow some ROBs to be missing. More...
Gaudi::Property< std::string >	m_robStatusCheckLevel
	Set behaviour for non-zero ROB status words. More...
Gaudi::Property< std::string >	m_robFormatCheckLevel
	Set behaviour for corrupted ROB data. More...
std::vector< uint32_t >	m_robIds
	Vector of ROB IDs to request, filled from all decoder tools in initialize. More...
std::set< uint32_t >	m_maybeMissingRobs
	Set of ROB IDs allowed to be missing because they are disabled. More...
ROBCheckBehaviour	m_robStatusCheck {ROBCheckBehaviour::Undefined}
ROBCheckBehaviour	m_robFormatCheck {ROBCheckBehaviour::Undefined}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. 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

Algorithm calling tools to convert L1 ByteStream into xAOD collections.

Definition at line 20 of file L1TriggerByteStreamDecoderAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

ROBCheckBehaviour

enum L1TriggerByteStreamDecoderAlg::ROBCheckBehaviour

strongprivate

The behaviour for non-zero ROB status words.

Enumerator
Undefined
None
Warning
Error
Fatal

Definition at line 95 of file L1TriggerByteStreamDecoderAlg.h.

{Undefined=-1, None, Warning, Error, Fatal};

Constructor & Destructor Documentation

L1TriggerByteStreamDecoderAlg()

L1TriggerByteStreamDecoderAlg::L1TriggerByteStreamDecoderAlg	(	const std::string &	name,
		ISvcLocator *	svcLoc
	)

Standard constructor.

Definition at line 70 of file L1TriggerByteStreamDecoderAlg.cxx.

: AthReentrantAlgorithm(name, svcLoc) {}

Member Function Documentation

cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

{
  return 0;
}

checkRobs()

StatusCode L1TriggerByteStreamDecoderAlg::checkRobs ( const IROBDataProviderSvc::VROBFRAG &  robs, std::string_view  toolName, const EventContext &  eventContext  ) const

private

Check ROB status word and report if different from zero.

Definition at line 239 of file L1TriggerByteStreamDecoderAlg.cxx.

                                                                                            {
  StatusCode sc{StatusCode::SUCCESS};
  if (m_robStatusCheck == ROBCheckBehaviour::None && m_robFormatCheck == ROBCheckBehaviour::None) {
    return sc;
  }
  std::string corruptedFractionName{"CorruptedROBFraction_"};
  std::string errorFractionName{"ErroneousROBFraction_"};
  corruptedFractionName.append(toolName);
  errorFractionName.append(toolName);
  FractionPerLBNMonitor monCorruptedFraction{std::move(corruptedFractionName), eventContext.eventID().lumi_block(), static_cast<float>(robs.size()), m_monTool};
  FractionPerLBNMonitor monErrorFraction{std::move(errorFractionName), eventContext.eventID().lumi_block(), static_cast<float>(robs.size()), m_monTool};
  auto printCheckMsg = [this](std::ostringstream& ss, ROBCheckBehaviour checkBehaviour, bool maybeMissing, StatusCode& sc) {
      if (maybeMissing) {
        ss << " but it is allowed due to the detector mask or the " << m_maybeMissingRobsProp.name() << " property";
        ATH_MSG_DEBUG(ss.str());
      }
      else if (checkBehaviour==ROBCheckBehaviour::Warning) {ATH_MSG_WARNING(ss.str());}
      else if (checkBehaviour==ROBCheckBehaviour::Error) {ATH_MSG_ERROR(ss.str());}
      else if (checkBehaviour==ROBCheckBehaviour::Fatal) {
        ATH_MSG_ERROR(ss.str());
        sc = StatusCode::FAILURE;
      }
  };
 
  for (const IROBDataProviderSvc::ROBF* rob : robs) {
    // Format check
    if (m_robFormatCheck!=ROBCheckBehaviour::None && !rob->check_noex()) {
      ++monCorruptedFraction;
      const uint32_t id{rob->rob_source_id()}; // there's a small chance ID is also corrupted, but usually corruption affects latter words
      std::string hexRobId = u32toHexString(id);
      const bool maybeMissing{std::find(m_maybeMissingRobs.cbegin(),m_maybeMissingRobs.cend(),id) != m_maybeMissingRobs.cend()};
 
      Monitored::Scalar<std::string> monCorrupted{(maybeMissing ? "CorruptedROBAllowed" : "CorruptedROB"), hexRobId};
      Monitored::Group{m_monTool, monCorrupted};
 
      std::ostringstream ss;
      ss << "ROBFragment with ID " << hexRobId << " (" << eformat::helper::SourceIdentifier(id).human()
         << ") requested by " << toolName << " has corrupted data with ";
      printRobProblems(ss, rob);
      printCheckMsg(ss, m_robFormatCheck, maybeMissing, sc);
    }
    // Status check
    if (m_robStatusCheck!=ROBCheckBehaviour::None && rob->nstatus()>0 && rob->status()[0]!=0) {
      ++monErrorFraction;
      const uint32_t id{rob->rob_source_id()};
      std::string hexRobId = u32toHexString(id);
      const bool maybeMissing{std::find(m_maybeMissingRobs.cbegin(),m_maybeMissingRobs.cend(),id) != m_maybeMissingRobs.cend()};
 
      Monitored::Scalar<std::string> monErroneous{(maybeMissing ? "ErroneousROBAllowed" : "ErroneousROB"), hexRobId};
      Monitored::Group{m_monTool, monErroneous};
 
      std::ostringstream ss;
      ss << "ROBFragment with ID " << hexRobId << " (" << eformat::helper::SourceIdentifier(id).human()
         << ") requested by " << toolName << " has non-zero status 0x" << std::hex << rob->status()[0] << std::dec;
      printCheckMsg(ss, m_robStatusCheck, maybeMissing, sc);
    }
  }
  return sc;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode L1TriggerByteStreamDecoderAlg::execute ( const EventContext &  eventContext ) const

overridevirtual

Definition at line 160 of file L1TriggerByteStreamDecoderAlg.cxx.

                                                                                        {
  ATH_MSG_DEBUG("Executing " << name());
  auto monTimeExec = Monitored::Timer<std::chrono::duration<float, std::milli>>("TIME_execute");
 
  // Retrieve the BS data for all tools in one request to parallelise DCM->ROS network requests
  IROBDataProviderSvc::VROBFRAG vrobf;
  m_robDataProviderSvc->getROBData(eventContext, m_robIds, vrobf, name());
 
  // Filter ROB list for each tool and call the conversion
  for (const auto& decoderTool : m_decoderTools) {
    std::string toolName{decoderTool->name().substr(decoderTool->name().rfind('.')+1)};
    auto monTimePrep = Monitored::Timer<std::chrono::duration<float, std::milli>>("TIME_prepareROBs_"+toolName);
    IROBDataProviderSvc::VROBFRAG vrobfForTool;
    ATH_CHECK(filterRobs(vrobf, vrobfForTool, decoderTool->robIds(), toolName, eventContext));
    ATH_CHECK(checkRobs(vrobfForTool, toolName, eventContext));
    monTimePrep.stop();
    auto monTimeConv = Monitored::Timer<std::chrono::duration<float, std::milli>>("TIME_convert_"+toolName);
    try {
      ATH_CHECK(decoderTool->convertFromBS(vrobfForTool, eventContext));
    } catch (const std::exception& ex) {
      ATH_MSG_ERROR("Exception in " << toolName << "::convertFromBS: " << ex.what());
      return StatusCode::FAILURE;
    }
    // Note: time histograms not filled if any ATH_CHECK above fails
    Monitored::Group(m_monTool, monTimePrep, monTimeConv);
  }
 
  Monitored::Group(m_monTool, monTimeExec);
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 79 of file AthReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext &  ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

filterRobs()

StatusCode L1TriggerByteStreamDecoderAlg::filterRobs ( const IROBDataProviderSvc::VROBFRAG &  in, IROBDataProviderSvc::VROBFRAG &  out, const std::vector< uint32_t > &  ids, std::string_view  toolName, const EventContext &  eventContext  ) const

private

Copy over ROBFragment pointers from in to out for ROBs with IDs from the ids list.

Parameters

[in]	in	The input vector of ROBFragments
[out]	out	The output vector of filtered ROBFragments
[in]	ids	A list of ROB IDs to filter from in to out
[in]	toolName	Name of the tool requesting the ROB IDs - used for log messages

Returns

FAILURE if any requested ROB IDs are missing from the in vector, otherwise SUCCESS

Definition at line 192 of file L1TriggerByteStreamDecoderAlg.cxx.

                                                                                             {
  std::copy_if(in.cbegin(), in.cend(), std::back_inserter(out),
               [&ids](const IROBDataProviderSvc::ROBF* rob){
                 return (std::find(ids.cbegin(),ids.cend(),rob->source_id()) != ids.cend());
               });
 
  std::string missingFractionName{"MissingROBFraction_"};
  missingFractionName.append(toolName);
  FractionPerLBNMonitor monMissingFraction{std::move(missingFractionName), eventContext.eventID().lumi_block(), static_cast<float>(ids.size()), m_monTool};
 
  // Check if all ROBs were found and report errors if not
  if (ids.size() != out.size()) {
    bool fail{false};
    for (const uint32_t id : ids) {
      auto eqRobId = [&id](const IROBDataProviderSvc::ROBF* rob){return (rob->source_id() == id);};
      if (std::find_if(out.cbegin(),out.cend(),eqRobId) == out.cend()) {
        ++monMissingFraction;
        std::string hexRobId = u32toHexString(id);
        if (std::find(m_maybeMissingRobs.cbegin(),m_maybeMissingRobs.cend(),id) != m_maybeMissingRobs.cend()) {
          ATH_MSG_DEBUG("Missing ROBFragment with ID " << hexRobId << " ("
                        << eformat::helper::SourceIdentifier(id).human() << ") requested by " << toolName
                        << " but it is allowed to be missing due to the detector mask or the "
                        << m_maybeMissingRobsProp.name() << " property");
          Monitored::Scalar<std::string> monMissing{"MissingROBAllowed", hexRobId};
          Monitored::Group{m_monTool, monMissing};
        } else {
          ATH_MSG_ERROR("Missing ROBFragment with ID " << hexRobId << " ("
                        << eformat::helper::SourceIdentifier(id).human() << ") requested by " << toolName);
          fail = true;
          Monitored::Scalar<std::string> monMissing{"MissingROB", hexRobId};
          Monitored::Group{m_monTool, monMissing};
        }
      }
    }
    if (fail) {
      return StatusCode::FAILURE;
    }
  }
  ATH_MSG_DEBUG("Found " << out.size() << " out of " << ids.size() << " ROBFragments requested by " << toolName);
  return StatusCode::SUCCESS;
}

finalize()

StatusCode L1TriggerByteStreamDecoderAlg::finalize ( )

overridevirtual

Definition at line 150 of file L1TriggerByteStreamDecoderAlg.cxx.

                                                   {
  ATH_MSG_DEBUG("Finalising " << name());
  ATH_CHECK(m_robDataProviderSvc.release());
  ATH_CHECK(m_decoderTools.release());
  return StatusCode::SUCCESS;
}

initialize()

StatusCode L1TriggerByteStreamDecoderAlg::initialize ( )

overridevirtual

Definition at line 76 of file L1TriggerByteStreamDecoderAlg.cxx.

                                                     {
  ATH_MSG_DEBUG("Initialising " << name());
  ATH_CHECK(m_decoderTools.retrieve());
  ATH_CHECK(m_robDataProviderSvc.retrieve());
  if (!m_monTool.empty()) ATH_CHECK(m_monTool.retrieve());
  ATH_CHECK(m_bsMetaDataContRHKey.initialize(SG::AllowEmpty));
  
  renounce(m_bsMetaDataContRHKey);
 
  // Build a list of unique ROB IDs to request in each event
  for (const auto& decoderTool : m_decoderTools) {
    const std::vector<uint32_t>& ids = decoderTool->robIds();
    m_robIds.insert(m_robIds.end(), ids.begin(), ids.end());
  }
  std::sort(m_robIds.begin(),m_robIds.end());
  m_robIds.erase(std::unique(m_robIds.begin(),m_robIds.end()), m_robIds.end());
  ATH_MSG_INFO("Will request " << m_robIds.size() << " ROBs per event: " << robIdsToString(m_robIds));
 
  // Parse properties
  m_maybeMissingRobs.insert(m_maybeMissingRobsProp.value().begin(), m_maybeMissingRobsProp.value().end());
 
  auto setRobCheckBehaviour = [this](const Gaudi::Property<std::string>& prop, ROBCheckBehaviour& out) -> StatusCode {
    if (prop.value() == "None") {out=ROBCheckBehaviour::None;}
    else if (prop.value() == "Warning") {out=ROBCheckBehaviour::Warning;}
    else if (prop.value() == "Error") {out=ROBCheckBehaviour::Error;}
    else if (prop.value() == "Fatal") {out=ROBCheckBehaviour::Fatal;}
    else {
      ATH_MSG_ERROR(prop.name() << " is set to \"" << prop.value()
                    << "\" but needs to be one of [\"None\", \"Warning\", \"Error\", \"Fatal\"]");
      return StatusCode::FAILURE;
    }
    return StatusCode::SUCCESS;
  };
 
  ATH_CHECK(setRobCheckBehaviour(m_robStatusCheckLevel,m_robStatusCheck));
  ATH_CHECK(setRobCheckBehaviour(m_robFormatCheckLevel,m_robFormatCheck));
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, InDet::SiSPGNNTrackMaker, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed ( bool  state, const EventContext &  ctx  ) const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

start()

StatusCode L1TriggerByteStreamDecoderAlg::start ( )

overridevirtual

Definition at line 119 of file L1TriggerByteStreamDecoderAlg.cxx.

                                                {
  // Skip detector mask checks if ByteStreamMetaData not available
  if (m_bsMetaDataContRHKey.key().empty()) {
    return StatusCode::SUCCESS;
  }
 
  // Get the detector mask
  auto bsmdc = SG::makeHandle(m_bsMetaDataContRHKey);
  ATH_CHECK(bsmdc.isValid());
  ATH_CHECK(!bsmdc->empty());
  const ByteStreamMetadata* metadata = bsmdc->front();
  const eformat::helper::DetectorMask detectorMask{metadata->getDetectorMask(), metadata->getDetectorMask2()};
 
  // Check if the requested ROBs should be expected to be present or may be missing
  for (const uint32_t robId : m_robIds) {
    const eformat::helper::SourceIdentifier sid{robId};
    if (!detectorMask.is_set(sid.subdetector_id())) {
      if (m_maybeMissingRobs.insert(robId).second) {
        ATH_MSG_WARNING("ROB ID 0x" << MSG::hex << robId << MSG::dec << " was requested for decoding, "
                        << "but the SubDetector " << sid.human_detector() << " is disabled in "
                        << "the detector mask. Will not require this ROB ID to be present in every event.");
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext &  ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

{
  return Gaudi::Algorithm::sysExecute (ctx);
}

sysInitialize()

StatusCode AthReentrantAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_bsMetaDataContRHKey

SG::ReadHandleKey<ByteStreamMetadataContainer> L1TriggerByteStreamDecoderAlg::m_bsMetaDataContRHKey

private

Initial value:

{
    this, "ByteStreamMetadataRHKey", "InputMetaDataStore+ByteStreamMetadata",
    "Key of the ByteStreamMetadataContainer to retrieve the detector mask"
  }

StoreGate key for the ByteStreamMetadata container to retrieve detector mask.

Definition at line 45 of file L1TriggerByteStreamDecoderAlg.h.

m_decoderTools

ToolHandleArray<IL1TriggerByteStreamTool> L1TriggerByteStreamDecoderAlg::m_decoderTools

private

Initial value:

{
    this, "DecoderTools", {}, "Array of tools performing the decoding work"}

Tool performing the decoding work.

Definition at line 34 of file L1TriggerByteStreamDecoderAlg.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

m_maybeMissingRobs

std::set<uint32_t> L1TriggerByteStreamDecoderAlg::m_maybeMissingRobs

private

Set of ROB IDs allowed to be missing because they are disabled.

Definition at line 93 of file L1TriggerByteStreamDecoderAlg.h.

m_maybeMissingRobsProp

Gaudi::Property<std::vector<uint32_t> > L1TriggerByteStreamDecoderAlg::m_maybeMissingRobsProp

private

Initial value:

{
    this, "MaybeMissingROBs", {},
    "List of ROB IDs allowed to be missing. If a decoder tool requests one of these "
    "and it is not available in the event, no errors will be reported",
    "appendList<T>"
  }

Allow some ROBs to be missing.

Definition at line 50 of file L1TriggerByteStreamDecoderAlg.h.

m_monTool

ToolHandle<GenericMonitoringTool> L1TriggerByteStreamDecoderAlg::m_monTool

private

Initial value:

{
    this, "MonTool", "", "Monitoring tool"}

Monitoring tool to create online histograms.

Definition at line 40 of file L1TriggerByteStreamDecoderAlg.h.

m_robDataProviderSvc

ServiceHandle<IROBDataProviderSvc> L1TriggerByteStreamDecoderAlg::m_robDataProviderSvc

private

Initial value:

{
    this, "ROBDataProviderSvc", "ROBDataProviderSvc", "ROB data provider"}

ROBDataProvider service handle.

Definition at line 37 of file L1TriggerByteStreamDecoderAlg.h.

m_robFormatCheck

ROBCheckBehaviour L1TriggerByteStreamDecoderAlg::m_robFormatCheck {ROBCheckBehaviour::Undefined}

private

Definition at line 97 of file L1TriggerByteStreamDecoderAlg.h.

m_robFormatCheckLevel

Gaudi::Property<std::string> L1TriggerByteStreamDecoderAlg::m_robFormatCheckLevel

private

Initial value:

{
    this, "ROBFormatCheckLevel", "Fatal",
    "ROB format (data consistency) check behaviour. Can be 'None' - format is not checked, 'Warning' - only print warnings "
    "for corrupted data, 'Error' - only print errors for corrupted data, 'Fatal' - return FAILURE "
    "from the algorithm if corrupted data are found. MaybeMissingROBs are always exempt from this check."
  }

Set behaviour for corrupted ROB data.

Definition at line 64 of file L1TriggerByteStreamDecoderAlg.h.

m_robIds

std::vector<uint32_t> L1TriggerByteStreamDecoderAlg::m_robIds

private

Vector of ROB IDs to request, filled from all decoder tools in initialize.

Definition at line 91 of file L1TriggerByteStreamDecoderAlg.h.

m_robStatusCheck

ROBCheckBehaviour L1TriggerByteStreamDecoderAlg::m_robStatusCheck {ROBCheckBehaviour::Undefined}

private

Definition at line 96 of file L1TriggerByteStreamDecoderAlg.h.

m_robStatusCheckLevel

Gaudi::Property<std::string> L1TriggerByteStreamDecoderAlg::m_robStatusCheckLevel

private

Initial value:

{
    this, "ROBStatusCheckLevel", "Warning",
    "ROB status word check behaviour. Can be 'None' - status is not checked, 'Warning' - only print warnings "
    "for non-zero status, 'Error' - only print errors for non-zero status, 'Fatal' - return FAILURE "
    "from the algorithm if non-zero status is found. MaybeMissingROBs are always exempt from this check."
  }

Set behaviour for non-zero ROB status words.

Definition at line 57 of file L1TriggerByteStreamDecoderAlg.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• L1TriggerByteStreamDecoderAlg.h
• L1TriggerByteStreamDecoderAlg.cxx