HedgehogBoard.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONMDT_CABLING_HEDGEHOGBOARD_H
#define MUONMDT_CABLING_HEDGEHOGBOARD_H
 
#include <array>
#include <string>
#include <cinttypes>
#include <optional>
#include <memory>
#include <iosfwd>
#include <CxxUtils/ArrayHelper.h>
 
namespace Muon{
    class HedgehogBoard{
        public:
            using HedgehogBoardPtr = std::shared_ptr<const HedgehogBoard>;
 
            static constexpr unsigned nChPerBoard = 24;
            using Mapping = std::array<uint8_t, nChPerBoard>;

            HedgehogBoard() = default;
            HedgehogBoard(const Mapping& map, 
                          const uint8_t nTubeLay,
                          const uint16_t boardId);
            bool operator<(const HedgehogBoard& other) const;
            uint16_t boardId() const;
            uint8_t numTubeLayers() const;
            uint8_t numTubesPerLayer() const;
            struct TubeLayer {
                uint8_t tube{0};
                uint8_t layer{0};
                bool operator==(const TubeLayer& other) const {
                    return tube == other.tube && layer == other.layer;
                }

                bool operator!=(const TubeLayer& other) const {
                    return tube != other.tube || layer != other.layer;
                }
                friend std::ostream& operator<<(std::ostream& ostr, const TubeLayer& tubeLay){
                    ostr<<"layer: "<<static_cast<int>(tubeLay.layer)
                        <<", tube: "<<static_cast<int>(tubeLay.tube);
                    return ostr;
                }
            };

            uint8_t pinNumber(const TubeLayer& tubeLay) const;
            uint8_t pinNumber(uint8_t layer, uint8_t  tube) const;
            uint8_t pairPin(const TubeLayer& tubeLay) const;
            uint8_t pairPin(uint8_t layer, uint8_t tube) const;            
            TubeLayer twinPair(const TubeLayer& tubeLay) const;
            TubeLayer twinPair(uint8_t layer, uint8_t tube) const;
            void setHVDelayTime(const double hvTime);
            bool hasHVDelayTime() const;
            double hvDelayTime() const;
            const Mapping& data() const;
        private:
            Mapping m_hedgePins{make_array<uint8_t, nChPerBoard>(-1)};
            uint8_t m_nTubeLay{0};
            uint8_t m_nTubePerLay{0};
            uint16_t m_id{0};
            std::optional<double> m_hvDelay{std::nullopt};
    };
    std::ostream& operator<<(std::ostream& ostr, const Muon::HedgehogBoard& board);
}
 
 
#endif