L1TriggerByteStreamDecoderAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGT1RESULTBYTESTREAM_L1TRIGGERBYTESTREAMDECODERALG_H
#define TRIGT1RESULTBYTESTREAM_L1TRIGGERBYTESTREAMDECODERALG_H
 
// Trigger includes
#include "TrigT1ResultByteStream/IL1TriggerByteStreamTool.h"
 
// Athena includes
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "AthenaMonitoringKernel/Monitored.h"
#include "ByteStreamCnvSvcBase/IROBDataProviderSvc.h"
#include "ByteStreamData/ByteStreamMetadataContainer.h"

class L1TriggerByteStreamDecoderAlg : public AthReentrantAlgorithm {
public:
  L1TriggerByteStreamDecoderAlg(const std::string& name, ISvcLocator* svcLoc);
 
  // ------------------------- AthReentrantAlgorithm methods -------------------
  virtual StatusCode initialize() override;
  virtual StatusCode start() override;
  virtual StatusCode finalize() override;
  virtual StatusCode execute(const EventContext& eventContext) const override;
 
private:
  // ------------------------- Tool/Service handles ----------------------------
  ToolHandleArray<IL1TriggerByteStreamTool> m_decoderTools {
    this, "DecoderTools", {}, "Array of tools performing the decoding work"};

  ServiceHandle<IROBDataProviderSvc> m_robDataProviderSvc {
    this, "ROBDataProviderSvc", "ROBDataProviderSvc", "ROB data provider"};

  ToolHandle<GenericMonitoringTool> m_monTool{
    this, "MonTool", "", "Monitoring tool"};
 
  // ------------------------- Properties --------------------------------------
  SG::ReadHandleKey<ByteStreamMetadataContainer> m_bsMetaDataContRHKey {
    this, "ByteStreamMetadataRHKey", "InputMetaDataStore+ByteStreamMetadata",
    "Key of the ByteStreamMetadataContainer to retrieve the detector mask"
  };

  Gaudi::Property<std::vector<uint32_t>> m_maybeMissingRobsProp {
    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",
    "OrderedSet<T>"
  };

  Gaudi::Property<std::string> m_robStatusCheckLevel {
    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."
  };

  Gaudi::Property<std::string> m_robFormatCheckLevel {
    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."
  };
 
  // ------------------------- Helper methods ----------------------------------
  StatusCode filterRobs(const IROBDataProviderSvc::VROBFRAG& in,
                        IROBDataProviderSvc::VROBFRAG& out,
                        const std::vector<uint32_t>& ids,
                        std::string_view toolName,
                        const EventContext& eventContext) const;
  StatusCode checkRobs(const IROBDataProviderSvc::VROBFRAG& robs, std::string_view toolName, const EventContext& eventContext) const;
 
  // ------------------------- Other private members ---------------------------
  std::vector<uint32_t> m_robIds;
  std::set<uint32_t> m_maybeMissingRobs;
  enum class ROBCheckBehaviour {Undefined=-1, None, Warning, Error, Fatal};
  ROBCheckBehaviour m_robStatusCheck{ROBCheckBehaviour::Undefined};
  ROBCheckBehaviour m_robFormatCheck{ROBCheckBehaviour::Undefined};
};
 
#endif // TRIGT1RESULTBYTESTREAM_L1TRIGGERBYTESTREAMDECODERALG_H