RoIBResultByteStreamTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRIGT1RESULTBYTESTREAM_ROIBRESULTBYTESTREAMTOOL_H
#define TRIGT1RESULTBYTESTREAM_ROIBRESULTBYTESTREAMTOOL_H
 
// Trigger includes
#include "L1TopoRDO/L1TopoRDO.h"
#include "TrigT1Interfaces/TrigT1StoreGateKeys.h"
#include "TrigT1Result/Header.h"
#include "TrigT1Result/Trailer.h"
#include "TrigT1ResultByteStream/IL1TriggerByteStreamTool.h"
 
// Athena includes:
#include "AthenaBaseComps/AthAlgTool.h"
#include "ByteStreamCnvSvcBase/IByteStreamEventAccess.h"
#include "ByteStreamData/RawEvent.h"
 
// System includes
#include <vector>
 
// Forward declaration(s):
namespace ROIB {
  class RoIBResult;
}

class RoIBResultByteStreamTool : public extends<AthAlgTool, IL1TriggerByteStreamTool> {
 
public:
  RoIBResultByteStreamTool( const std::string& type, const std::string& name,
                            const IInterface* parent );
  virtual ~RoIBResultByteStreamTool() = default;

  virtual StatusCode initialize() override;

  virtual StatusCode convertFromBS(const std::vector<const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment*>& vrobf,
                                   const EventContext& eventContext) const override;

  virtual StatusCode convertToBS(std::vector<OFFLINE_FRAGMENTS_NAMESPACE_WRITE::ROBFragment*>& vrobf,
                                 const EventContext& eventContext) override;

  virtual const std::vector<uint32_t>& robIds() const override {return m_configuredROBIds;}
 
private:
 
  // ------------------------- Private types -----------------------------------
  struct DataStatus {
    bool rob_error {false};
    bool rod_error {false};
    uint32_t status_word {0};
    uint32_t status_info {0};
  };
 
  // ------------------------- Private methods ---------------------------------
  ROIB::Header roibHeader(const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment& rob, DataStatus& dataStatus) const;

  template<typename RoIType> std::vector<RoIType> roibContent(const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment& rob) const;

  L1TopoRDO l1topoContent(const OFFLINE_FRAGMENTS_NAMESPACE::ROBFragment& rob) const;

  ROIB::Trailer roibTrailer(const DataStatus& dataStatus, const uint32_t dataSize) const;
 
  // ------------------------- Properties --------------------------------------
  Gaudi::Property<uint16_t> m_ctpModuleID {
    this, "CTPModuleId", 1,
    "Module ID of CTP ROB with RoI information. Value 0xFF disables CTP decoding/encoding in this tool."
  };

  Gaudi::Property<uint16_t> m_muCTPIModuleID {
    this, "MUCTPIModuleId", 1,
    "Module ID of MUCTPI ROB with RoI information. Value 0xFF disables MUCTPI decoding/encoding in this tool."
  };

  Gaudi::Property<std::vector<uint16_t>> m_jetModuleID {
    this, "JetModuleIds", {0xac, 0xad},
    "Vector of module IDs of Jet RoI ROBs. Empty vector disables Jet/Energy decoding/encoding in this tool."
  };

  Gaudi::Property<std::vector<uint16_t>> m_emModuleID {
    this, "EMModuleIds", {0xa8, 0xa9, 0xaa, 0xab},
    "Vector of module IDs of EM RoI ROBs. Empty vector disables EMTau decoding/encoding in this tool."
  };

  Gaudi::Property<std::vector<uint16_t>> m_l1TopoModuleID {
    this, "L1TopoModuleIds", {0x81,0x91},
    "Vector of module IDs of L1Topo RoI ROBs. Empty vector disables L1Topo decoding/encoding in this tool."
  };


  Gaudi::Property<uint16_t> m_detEvType {
    this, "DetEvType", 1, // RB: It was hard-coded to 1 in the past, no idea why
    "Detector event type to write when converting to ByteStream"
  };

  SG::WriteHandleKey<ROIB::RoIBResult> m_roibResultWriteKey {
    this, "RoIBResultWriteKey", "",
    "Write handle key to RoIBResult for conversion from ByteStream"
  };
  SG::ReadHandleKey<ROIB::RoIBResult> m_roibResultReadKey {
    this, "RoIBResultReadKey", "",
    "Read handle key to RoIBResult for conversion to ByteStream"
  };

 
  // ------------------------- Other private members ---------------------------
  std::vector<uint32_t> m_configuredROBIds;
  SmartIF<IByteStreamEventAccess> m_byteStreamEventAccess;
  bool m_doCTP {true};
  bool m_doMuon {true};
  bool m_doJetEnergy {true};
  bool m_doEMTau {true};
  bool m_doTopo {true};
 
}; // class RoIBResultByteStreamTool
 
#endif // TRIGT1RESULTBYTESTREAM_ROIBRESULTBYTESTREAMTOOL_H