SCT_RodEncoder.h

Go to the documentation of this file.

// -*- C++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef SCT_RAWDATABYTESTREAMCNV_SCT_RODENCODER_H
#define SCT_RAWDATABYTESTREAMCNV_SCT_RODENCODER_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "SCT_RawDataByteStreamCnv/ISCT_RodEncoder.h"
 
#include "InDetRawData/SCT_RDO_Container.h"
#include "SCT_ConditionsTools/ISCT_ByteStreamErrorsTool.h"
 
#include "GaudiKernel/ToolHandle.h"
 
#include <set>
 
class ISCT_CablingTool;
class SCT_ID;
class SCT_RDORawData;
class Identifier;
class IdentifierHash;

class SCT_RodEncoder : public extends<AthAlgTool, ISCT_RodEncoder>
{ 
 public:
 
  SCT_RodEncoder(const std::string& type, const std::string& name, const IInterface* parent);

  virtual ~SCT_RodEncoder() = default;

  virtual StatusCode initialize() override;

  virtual StatusCode finalize() override;

  virtual void fillROD(std::vector<uint32_t>& vec32Data, const uint32_t& robID, 
                       const std::vector<const SCT_RDORawData*>& vecRDOs) const override;
 
 private:
  
  enum ErrorWords{TIMEOUT_ERR=(1<<11),
                  L1_ERR=(1<<10),
                  BCID_ERR=(1<<9),
                  PREAMBLE_ERR=(1<<12),
                  FORMATTER_ERR=12,
                  TRAILER_ERR=(1<<12),
                  NULL_HEADER_ERR=0,
                  HEADER_TRAILER_ERR=(1<<11),
                  TRAILER_OVFLW_ERR=(1<<10),
                  ABCD_ERR=0,
                  RAWDATA_ERR=(3<<13),
                  NULL_TRAILER_ERR=0};

  void encodeData(const std::vector<int>& vecTimeBins, std::vector<uint16_t>& vec16Words, 
                  const SCT_RDORawData* rdo, const int& groupSize, const int& strip) const;
  
  void packFragments(std::vector<uint16_t>& vec16Words, std::vector<uint32_t>& vec32Words) const;

  uint32_t set32Bits(const unsigned short int* arr16Words, 
                     const unsigned short int* position, 
                     const unsigned short int& numWords) const;

  int side(const SCT_RDORawData* rdo) const;
  
  int getTimeBin(const SCT_RDORawData* rdo) const;
  
  int getStrip(const SCT_RDORawData* rdo) const;
 
  Identifier offlineID(const SCT_RDORawData* rdo) const;

  uint32_t onlineID(const SCT_RDORawData* rdo) const;

  int getRODLink(const SCT_RDORawData* rdo) const;

  uint16_t getHeaderUsingRDO(const SCT_RDORawData* rdo) const;
  
  uint16_t getHeaderUsingHash(const IdentifierHash& linkHash, const int& errorWord) const;
  
  uint16_t getTrailer(const int& errorWord) const;

  void addHeadersWithErrors(const uint32_t& robID, const std::set<IdentifierHash>* errors, 
                            const ErrorWords& errType, std::vector<uint16_t>& vec16Data) const;

  void addTrailersWithErrors(const uint32_t& robID, const std::set<IdentifierHash>* errors, 
                             const ErrorWords& errType, std::vector<uint16_t>& vec16Data) const;

  void addSpecificErrors(const uint32_t& robID, const std::set<IdentifierHash>* errors, 
                         const ErrorWords& errType, std::vector<uint16_t>& vec16Data) const;

  ToolHandle<ISCT_ByteStreamErrorsTool> m_bsErrTool{this, 
                                                    "SCT_ByteStreamErrorsTool", 
                                                    "SCT_ByteStreamErrorsTool", 
                                                    "Tool to retrieve SCT ByteStream Errors"};
  
  ToolHandle<ISCT_CablingTool> m_cabling{this, 
                                         "SCT_CablingTool", 
                                         "SCT_CablingTool", 
                                         "Tool to retrieve SCT Cabling"};

  const SCT_ID* m_sctID{nullptr};

  BooleanProperty m_condensed{this, 
                              "CondensedMode", 
                              false, 
                              "Condensed mode (true) or Expanded mode (false)"};

  std::set<Identifier> m_swapModuleID{};
};
 
#endif // SCT_RAWDATABYTESTREAMCNV_SCT_RODENCODER_H