LArFebHeader.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef LARFEBHEADER_H
#define LARFEBHEADER_H
 
#include "Identifier/HWIdentifier.h"
#include <cstdint>
 
 
class LArFebHeader
{
 public:
 
  struct RodHeader {
    uint32_t FormatVersion{};
    uint32_t SourceId{};
    uint32_t RunNumber{};
    uint16_t ELVL1Id{};
    uint16_t BCId{};
    uint32_t LVL1TigType{};
    uint32_t DetEventType{};
  }; 
 
  struct DspHeader {
    uint32_t CodeVersion{};  // DSP code version
    uint32_t EventCounter{}; // DSP event counter
  };
 
 
  LArFebHeader();
 
  LArFebHeader(const HWIdentifier febid);
 
  ~LArFebHeader() = default;
 
  inline HWIdentifier FEBId() const {return m_FEBId;}
 
  inline uint32_t FormatVersion() const {return m_RodHeader.FormatVersion;}
 
  inline uint32_t SourceId() const {return m_RodHeader.SourceId;}
 
  inline uint32_t RunNumber() const {return m_RodHeader. RunNumber;}
 
  inline uint16_t ELVL1Id() const {return m_RodHeader.ELVL1Id;}
 
  inline uint16_t BCId() const {return m_RodHeader.BCId;}
 
  inline uint32_t LVL1TigType() const {return m_RodHeader.LVL1TigType;}
 
  inline uint32_t DetEventType() const {return m_RodHeader.DetEventType;}
 
  inline uint32_t DspCodeVersion() const {return m_DspHeader.CodeVersion;}
 
  inline uint32_t DspEventCounter() const {return m_DspHeader.EventCounter;}
 
  inline uint16_t FebELVL1Id() const {return m_ELVL1Id;}
 
  inline uint16_t FebBCId() const {return m_BCId;}
 
  inline uint16_t RodResults1Size() const {return m_Results1Size;}
  inline uint16_t RodResults2Size() const {return m_Results2Size;}
  inline uint16_t RodRawDataSize()  const {return m_RawDataSize;}
 
  inline uint16_t NbSamples()     const {return m_NbSamples;}
  inline uint16_t NbSweetCells1() const {return m_NbSweetCells1;}
  inline uint16_t NbSweetCells2() const {return m_NbSweetCells2;}
  inline uint32_t OnlineChecksum()  const { return m_OnlineChecksum; }
  inline uint32_t OfflineChecksum() const { return m_OfflineChecksum; }
  inline bool     ChecksumVerification() const { return m_OnlineChecksum==m_OfflineChecksum; }
 
  inline const std::vector <uint16_t> & FebCtrl1()  const {return m_Ctrl1;}
 
  inline const std::vector <uint16_t> & FebCtrl2()  const {return m_Ctrl2;}
 
  inline const std::vector <uint16_t> & FebCtrl3()  const {return m_Ctrl3;}
 
  inline uint32_t RodStatus() const {return m_Status;}
 
  inline const std::vector <uint16_t> & SCA() const { return m_SCA; }
 
  inline bool CheckErrorELVL1Id() const { return (m_RodHeader.ELVL1Id&0x1f)!=m_ELVL1Id; }
 
  inline bool CheckErrorBCId() const { return m_RodHeader.BCId!=((m_BCId+1)&0xfff); }
 
  inline void SetFormatVersion(const uint32_t formatVersion)
    { m_RodHeader.FormatVersion=formatVersion; return; }
 
  inline void SetSourceId(const uint32_t sourceID)
    { m_RodHeader.SourceId=sourceID; return; }
 
  inline void SetRunNumber(const uint32_t runNumber)
    { m_RodHeader.RunNumber=runNumber; return; }
 
  inline void SetELVL1Id(const uint16_t elvl1Id)
    { m_RodHeader.ELVL1Id=elvl1Id; return; }
 
  inline void SetBCId(const uint16_t bcid)
    { m_RodHeader.BCId=bcid; return; }
 
  inline void SetRodResults1Size(const uint16_t size)
    { m_Results1Size=size; return; }
  inline void SetRodResults2Size(const uint16_t size)
    { m_Results2Size=size; return; }
  inline void SetRodRawDataSize (const uint16_t size)
    { m_RawDataSize=size; return; }
 
  inline void SetNbSweetCells1(const uint16_t n)
    { m_NbSweetCells1=n; return; }
  inline void SetNbSweetCells2(const uint16_t n)
    { m_NbSweetCells2=n; return; }
  inline void SetNbSamples(const uint16_t n)
    { m_NbSamples=n; return; }
  inline void SetOnlineChecksum(const uint32_t checksum)
    { m_OnlineChecksum=checksum; return; }
  inline void SetOfflineChecksum(const uint32_t checksum)
    { m_OfflineChecksum=checksum; return; }
 
  inline void SetLVL1TigType(const uint32_t lvl1ttype)
    { m_RodHeader.LVL1TigType=lvl1ttype; return; }
 
  inline void SetDetEventType(const uint32_t detEvType)
    { m_RodHeader.DetEventType=detEvType; return; }
 
  inline void SetDspCodeVersion(const uint32_t codeVersion)
    { m_DspHeader.CodeVersion=codeVersion; return; }
 
  inline void SetDspEventCounter(const uint32_t eventCounter)
    { m_DspHeader.EventCounter=eventCounter; return; }
 
  inline void SetFebELVL1Id(const uint16_t elvl1Id)
    { m_ELVL1Id=elvl1Id; return; }
 
  inline void SetFebBCId(const uint16_t bcid)
    { m_BCId=bcid; return; }
 
  inline void SetFebCtrl1(const uint16_t ctrl1)
    { m_Ctrl1.push_back(ctrl1); return; }
 
  inline void SetFebCtrl2(const uint16_t ctrl2)
    { m_Ctrl2.push_back(ctrl2); return; }
 
  inline void SetFebCtrl3(const uint16_t ctrl3)
    { m_Ctrl3.push_back(ctrl3); return; }
 
  inline void SetRodStatus(const uint32_t status)
    { m_Status=status; return; }
 
  inline void SetFebSCA(const uint16_t sca)
    { m_SCA.push_back(degray(sca)); return; }
 
 
 
 
 private:
 
  static int degray(unsigned int x);
 
  const HWIdentifier m_FEBId{};
 
  RodHeader m_RodHeader{};
 
  DspHeader m_DspHeader{};
 
  uint16_t m_ELVL1Id{};
 
  uint16_t m_BCId{};
 
  uint16_t m_Results1Size{};
  uint16_t m_Results2Size{};
  uint16_t m_RawDataSize{};
  uint16_t m_NbSweetCells1{};
  uint16_t m_NbSweetCells2{};
  uint16_t m_NbSamples{};
  uint32_t m_OnlineChecksum{1};
  uint32_t m_OfflineChecksum{};
 
  uint32_t m_Status{};
 
  std::vector<uint16_t> m_SCA;
 
  std::vector<uint16_t> m_Ctrl1;
 
  std::vector<uint16_t> m_Ctrl2;
 
  std::vector<uint16_t> m_Ctrl3;
};
 
#include "AthenaKernel/CLASS_DEF.h"
CLASS_DEF( LArFebHeader , 149839963 , 1 )
#endif