da/d9c/MuonTGC__CablingSvc_8h_source.html

/*

  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration

*/


/***************************************************************************

    MuonTGC_CablingSvc.h


    Author : Toshi.Sumida@cern.ch, Susumu.Oda@cern.ch, Hisaya.Kurashige@cern.ch

    Created from TGCcabling12Svc.cxx in June, 2009

    Description : online-offline ID mapper for TGC


***************************************************************************/


#ifndef MUONTGC_CABLING_MUONTGC_CABLINGSVC_H

#define MUONTGC_CABLING_MUONTGC_CABLINGSVC_H


#include "TGCcablingInterface/ITGCcablingSvc.h"

#include "GaudiKernel/ServiceHandle.h"

#include "GaudiKernel/ToolHandle.h"


#include "MuonCondInterface/ITGCCablingDbTool.h"

#include "AthenaKernel/IOVSvcDefs.h"

#include "GaudiKernel/Service.h"

#include "MuonTGC_Cabling/TGCCabling.h"

#include "MuonIdHelpers/IMuonIdHelperSvc.h"


#include <string>

#include <vector>


class MuonTGC_CablingSvc : public ITGCcablingSvc

{

 public:

  MuonTGC_CablingSvc(const std::string& name, ISvcLocator* svc);

  virtual ~MuonTGC_CablingSvc()=default;


  static const InterfaceID& interfaceID(void)

    {

      return  IID_TGCcablingSvc;

    }


  virtual StatusCode queryInterface(const InterfaceID& riid, void** ppvIF) override;


  virtual StatusCode initialize(void) override;

  virtual StatusCode finalize(void) override;


  virtual const TGCCablingBase* getTGCCabling(void) const override;


  // give max value of ReadoutID parameters

  virtual

  void getReadoutIDRanges(int& maxRodId,

                          int& maxSRodId,

              int& maxSswId,

              int& maxSbloc,

              int& minChannelId,

              int& maxChannelId) const override;


  // give phi-range which a ROD covers

  virtual

  bool getCoveragefromRodID(const int rodID,

                double & startPhi,

                double & endPhi) const override;


  virtual

  bool getCoveragefromRodID(const int rodID,

                int & startEndcapSector,

                int & coverageOfEndcapSector,

                int & startForwardSector,

                int & coverageOfForwardSector) const override;


  // give phi-range which a SROD covers

  virtual

  bool getCoveragefromSRodID(const int srodID,

                double & startPhi,

                double & endPhi) const override;


  virtual

  bool getCoveragefromSRodID(const int srodID,

                             int & startEndcapSector,

                             int & coverageOfEndcapSector,

                             int & startForwardSector,

                             int & coverageOfForwardSector) const override;


  // Readout ID is ored

  virtual

  bool isOredChannel(const int subDetectorID,

             const int rodID,

             const int sswID,

             const int sbLoc,

             const int channelID) const override;


  // Offline ID has adjacent Readout ID

  virtual

  bool hasAdjacentChannel(const Identifier & offlineID) const override;


  // Online ID has adjacent Readout ID

  virtual

  bool hasAdjacentChannel(const int subsystemNumber,

              const int octantNumber,

              const int moduleNumber,

              const int layerNumber,

              const int rNumber,

              const int wireOrStrip,

              const int channelNumber) const override;


  // readout IDs -> offline IDs

  virtual

  bool getOfflineIDfromReadoutID(Identifier & offlineID,

                 const int subDetectorID,

                 const int rodID,

                 const int sswID,

                 const int sbLoc,

                 const int channelID,

                 bool orChannel=false) const override;


  // offline IDs -> readout IDs

  virtual

  bool getReadoutIDfromOfflineID(const Identifier & offlineID,

                 int & subDetectorID,

                 int & rodID,

                 int & sswID,

                 int & sbLoc,

                 int & channelID,

                 bool adChannel=false) const override;


  // offline ID -> online IDs

  virtual

  bool getOnlineIDfromOfflineID(const Identifier & offlineID,

                int & subsystemNumber,

                int & octantNumber,

                int & moduleNumber,

                int & layerNumber,

                int & rNumber,

                int & wireOrStrip,

                int & channelNumber) const override;


  // online IDs -> offline ID

  virtual

  bool getOfflineIDfromOnlineID(Identifier & offlineID,

                const int subsystemNumber,

                const int octantNumber,

                const int moduleNumber,

                const int layerNumber,

                const int rNumber,

                const int wireOrStrip,

                const int channelNumber) const override;


  // readout IDs -> online IDs

  virtual

  bool getOnlineIDfromReadoutID(const int subDetectorID,

                const int rodID,

                const int sswID,

                const int sbLoc,

                const int channelID,

                int & subsystemNumber,

                int & octantNumber,

                int & moduleNumber,

                int & layerNumber,

                int & rNumber,

                int & wireOrStrip,

                int & channelNumber,

                bool orChannel=false) const override;


  // online IDs -> readout IDs

  virtual

  bool getReadoutIDfromOnlineID(int & subDetectorID,

                int & rodID,

                int & sswID,

                int & sbLoc,

                int & channelID,

                const int subsystemNumber,

                const int octantNumber,

                const int moduleNumber,

                const int layerNumber,

                const int rNumber,

                const int wireOrStrip,

                const int channelNumber,

                bool adChannel=false) const override;


  // element ID -> readout IDs

  virtual

  bool getReadoutIDfromElementID(const Identifier & elementID,

                 int & subdetectorID,

                 int & rodID) const override;


  // readout IDs -> element ID

  virtual

  bool getElementIDfromReadoutID(Identifier & elementID,

                 const int subDetectorID,

                 const int rodID,

                 const int sswID,

                 const int sbLoc,

                 const int channelID,

                 bool orChannel=false) const override;


  // HPT ID -> readout ID

  virtual

  bool getReadoutIDfromHPTID(const int phi,

                 const bool isAside,

                 const bool isEndcap,

                 const bool isStrip,

                 const int id,

                 int & subsectorID,

                 int & rodID,

                 int & sswID,

                 int & sbLoc) const override;


  // readout ID -> SLB ID

  virtual

  bool getSLBIDfromReadoutID(int &phi,

                 bool & isAside,

                 bool & isEndcap,

                 int & moduleType,

                 int & id,

                 const int subsectorID,

                 const int rodID,

                 const int sswID,

                 const int sbLoc) const override;


  // readout ID -> slbAddr

  virtual

  bool getSLBAddressfromReadoutID(int & slbAddr,

                  const int subsectorID,

                  const int rodID,

                  const int sswID,

                  const int sbLoc) const override;


  // readout ID -> RxID

  virtual

  bool getRxIDfromReadoutID(int & rxId,

                const int subsectorID,

                const int rodID,

                const int sswID,

                const int sbLoc) const override;


  // ROD_ID / SSW_ID / RX_ID -> SLB ID

  virtual

  bool getSLBIDfromRxID(int &phi,

            bool & isAside,

            bool & isEndcap,

            int & moduleType,

            int & id,

            const int subsectorID,

            const int rodID,

            const int sswID,

            const int rxId) const override;


  // SLB ID -> readout ID

  virtual

  bool getReadoutIDfromSLBID(const int phi,

                 const bool isAside,

                 const bool isEndcap,

                 const int moduleType,

                 const int id,

                 int & subsectorID,

                 int & rodID,

                 int & sswID,

                 int & sbLoc) const override;


  // readout ID (ROD) -> SL ID

  virtual

  bool getSLIDfromReadoutID(int & phi,

                bool & isAside,

                bool & isEndcap,

                const int subsectorID,

                const int rodID,

                const int sswID,

                const int sbLoc) const override;


  // readout ID (SROD) -> SL ID

  virtual

  bool getSLIDfromSReadoutID(int & phi,

                             bool & isAside,

                             const int subsectorID,

                             const int srodID,

                             const int sector,

                             const bool forward) const override;


  // SL ID -> readout ID ( ROD )

  virtual

  bool getReadoutIDfromSLID(const int phi,

                const bool isAside,

                const bool isEndcap,

                int & subsectorID,

                int & rodID,

                int & sswID,

                int & sbLoc) const override;


  // SL ID -> readout ID ( SROD )

  virtual

  bool getSReadoutIDfromSLID(const int phi,

                             const bool isAside,

                             const bool isEndcap,

                             int & subsectorID,

                             int & srodID,

                             int & sswID,

                             int & sbLoc) const override;


  // HighPtID used in Simulation -> HighPtID in RDO

  virtual

  bool getRDOHighPtIDfromSimHighPtID(const bool isForward,

                                     const bool isStrip,

                                     int & index,

                                     int & chip,

                                     int & hitId) const override;


  // HighPtID in RDO -> HighPtID used in Simulation

  virtual

  bool getSimHighPtIDfromRDOHighPtID(const bool isForward,

                                     const bool isStrip,

                                     int & index,

                                     int & chip,

                                     int & hitId) const override;


  // high pt coincidence IDs -> offline IDs

  virtual

    bool getOfflineIDfromHighPtID(Identifier & offlineID,

                  const int subDetectorID,

                  const int rodID,

                  const int sectorInReadout,

                  const bool isStrip,

                  const bool isForward,

                  const int hpb,

                  const int chip,

                  const int hitID,

                  const int pos ) const override;


  // offline IDs -> high pt coincidence IDs

  virtual

    bool getHighPtIDfromOfflineID(const Identifier & offlineID,

                  int & subDetectorID,

                  int & rodID,

                  int & sectorInReadout,

                  bool & isStrip,

                  bool & isForward,

                  int & hpb,

                  int & chip,

                  int & hitID,

                  int & pos) const override;


  // HPT HitID -> ROI Number

  virtual

    bool getROINumberfromHighPtID(int &roi,

                  bool isForward,

                  int hpb_wire,

                  int chip_wire,

                  int hitId_wire,

                  int sub_wire,

                  int chip_strip,

                  int hitId_strip,

                  int sub_strip) const override;


  // HPT HitID -> ROI Number

  virtual

     bool getHighPtIDfromROINumber(int roi,

                   bool isForward,

                   bool isStrip,

                   int & hpb,

                   int & chip,

                   int & hitID,

                   int & sub) const override;


  // low pt coincidence IDs -> offline IDs

  virtual

    bool getOfflineIDfromLowPtCoincidenceID(Identifier & offlineID,

                        const int subDetectorID,

                        const int rodID,

                        const int sswID,

                        const int sbLoc,

                        const int block,

                        const int pos,

                        bool middle=false) const override;


  // offline IDs -> low pt coincidence IDs

  virtual

    bool getLowPtCoincidenceIDfromOfflineID(const Identifier & offlineID,

                        int & subDetectorID,

                        int & rodID,

                        int & sswID,

                        int & sbLoc,

                        int & block,

                        int & pos,

                        bool middle=false) const override;


  // channel connection

  MuonTGC_Cabling::TGCChannelId*

    getChannel(const MuonTGC_Cabling::TGCChannelId* channelId,

           TGCIdBase::ChannelIdType type,

           bool orChannel=false) const;


  // module connection

  MuonTGC_Cabling::TGCModuleMap*

    getModule(const MuonTGC_Cabling::TGCModuleId* moduleId,

          MuonTGC_Cabling::TGCModuleId::ModuleIdType type) const;


 private:

  MuonTGC_Cabling::TGCCabling* m_cabling;

  ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

  ToolHandle<ITGCCablingDbTool> m_condDataTool{this,"TGCCablingDbTool","TGCCablingDbTool"};

};


inline const TGCCablingBase* MuonTGC_CablingSvc::getTGCCabling(void) const

{

  return m_cabling;

}


#endif // MUONTGC_CABLING_MUONTGC_CABLINGSVC_H