ICandData.h

Go to the documentation of this file.

/*
   Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef L1MuonInterface_ICANDDATA_H
#define L1MuonInterface_ICANDDATA_H
 
#include <cstdint>
#include <cmath>
 
namespace L1Muon
{
 
  class ICandData
  {
  public:
    // default constructor
    ICandData(uint16_t subdetectorId, uint16_t sectorId, uint16_t bcTag)
        : m_subdetectorId(subdetectorId), m_sectorId(sectorId), m_bcTag(bcTag) {}
 
    ICandData() = default;
    virtual ~ICandData() = default;
 
    uint16_t subdetectorId() const { return m_subdetectorId; };
    uint16_t sectorId() const { return m_sectorId; };
    uint16_t bcTag() const { return m_bcTag; };
    uint8_t threshold() const { return m_threshold; };
    uint8_t charge() const { return m_charge; };
    uint8_t mdtFlag() const { return m_mdtFlag; };
    float eta() const;
    float phi() const;
    float pt() const;

    void setEta(float eta);
    void setPhi(float phi);
    void setPt(float pt);
    void setThreshold(float threshold) { m_threshold = threshold; }
    void setCharge(uint8_t charge) { m_charge = charge; }
    void setMdtFlag(uint8_t mdtFlag) { m_mdtFlag = mdtFlag; }
 
    enum class BC_ID
    {
      BC_UNDEFINED = 0,
      BC_PREVIOUS,
      BC_CURRENT,
      BC_NEXT,
      BC_NEXTNEXT
    };
 
  private:
    static constexpr float s_etaRange = 2.7;
    static constexpr float s_phiRange = 2.0 * M_PI;
    static constexpr float s_ptRange = 1000.0;

    static constexpr uint16_t s_etaBitRange = 0x3fff;
    static constexpr uint16_t s_phiBitRange = 0x1ff;
    static constexpr uint16_t s_ptBitRange = 0xff;
 
    // number of the subdetector
    uint16_t m_subdetectorId{0};
    uint16_t m_sectorId{0};
    uint16_t m_bcTag{0};
    uint16_t m_eta{0};
    uint16_t m_phi{0};
    uint16_t m_pt{0};
    uint8_t m_threshold{0};
    uint8_t m_charge{0};
    uint8_t m_mdtFlag{0};
  };
}
 
#endif