MdtCablingData.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONMDT_CABLING_MDTCABLINGDATA_H
#define MUONMDT_CABLING_MDTCABLINGDATA_H
 
#include <cstdint>
#include <iosfwd>
/*
 * @brief: Helper struct containing all information to convert from the offline
 * identifiers to the online identifiers
 */

struct MdtCablingOffData {
    MdtCablingOffData() = default;
    MdtCablingOffData(const MdtCablingOffData& other) : MdtCablingOffData() {
        m_cache.hash = other.m_cache.hash;
    }
    // cppcheck-suppress operatorEqVarError; stationIndex, etc intentionally not copied.
    MdtCablingOffData& operator=(const MdtCablingOffData& other) {
        if (&other != this)
            m_cache.hash = other.m_cache.hash;
        return *this;
    }
    int8_t& stationIndex{
        m_cache.cache[0]};  
    int8_t& eta{m_cache.cache[1]};         
    int8_t& phi{m_cache.cache[2]};         
    int8_t& multilayer{m_cache.cache[3]};  

    bool operator==(const MdtCablingOffData& other) const {
        return m_cache.hash == other.m_cache.hash;
    }
    bool operator!=(const MdtCablingOffData& other) const {
        return m_cache.hash != other.m_cache.hash;
    }
    bool operator<(const MdtCablingOffData& other) const {
        return m_cache.hash < other.m_cache.hash;
    }
    bool operator!() const { return !m_cache.hash; }
 
   private:
    union {
        int hash{0};
        int8_t cache[4];
    } m_cache{};
};
struct MdtCablingOnData {
    MdtCablingOnData() = default;
    uint8_t& mrod{m_cache.cache[0]};           
    uint8_t& csm{m_cache.cache[1]};            
    uint8_t& subdetectorId{m_cache.cache[2]};  
 
    MdtCablingOnData(const MdtCablingOnData& other) : MdtCablingOnData() {
        m_cache.hash = other.m_cache.hash;
    }
    // cppcheck-suppress operatorEqVarError; subDetectorId, etc intentionally not copied.
    MdtCablingOnData& operator=(const MdtCablingOnData& other) {
        if (&other != this)
            m_cache.hash = other.m_cache.hash;
        return *this;
    }
 
    bool operator==(const MdtCablingOnData& other) const {
        return m_cache.hash == other.m_cache.hash;
    }
    bool operator!=(const MdtCablingOnData& other) const {
        return m_cache.hash != other.m_cache.hash;
    }
    bool operator<(const MdtCablingOnData& other) const {
        return m_cache.hash < other.m_cache.hash;
    }
    bool operator!() const { return !m_cache.hash; }
 
   private:
    union {
        int hash{0};
        uint8_t cache[4];
    } m_cache{};
};
struct MdtCablingData : public MdtCablingOffData, MdtCablingOnData {
    MdtCablingData() = default;
 
    int layer{-99};  
    int tube{-99};   
 
    uint8_t mezzanine_type{0};  
    uint8_t tdcId{0xFF};  
 
    uint8_t channelId{
        0xff};  

    static constexpr int legacy_tube_block_size = 100;
    static constexpr int legacy_layer_block_size = 10;

    int tubes_per_layer{legacy_tube_block_size};
    int layer_block{legacy_layer_block_size};

    bool operator==(const MdtCablingData& other) const {
        return this->MdtCablingOffData::operator==(other) &&
               this->MdtCablingOnData::operator==(other) &&
               tdcId == other.tdcId && layer == other.layer &&
               tube == other.tube && channelId == other.channelId;
    }
    bool operator!=(const MdtCablingData& other) const {
        return !((*this) == other);
    }
    bool operator<(const MdtCablingData& other) const {
        if (this->MdtCablingOffData::operator!=(other))
            return this->MdtCablingOffData::operator<(other);
        if (this->MdtCablingOnData::operator!=(other))
            return this->MdtCablingOnData::operator<(other);
        if (tdcId != other.tdcId)
            return tdcId < other.tdcId;
        return channelId < other.channelId;
    }
};
 
std::ostream& operator<<(std::ostream& ostr, const MdtCablingData& obj);
 
std::ostream& operator<<(std::ostream& ostr, const MdtCablingOffData& obj);
std::ostream& operator<<(std::ostream& ostr, const MdtCablingOnData& obj);
 
#endif