HcalElectronicsId.h

Go to the documentation of this file.

#ifndef DATAFORMATS_HCALDETID_HCALELECTRONICSID_H
#define DATAFORMATS_HCALDETID_HCALELECTRONICSID_H 1

#include <string>
#include <ostream>
#include <cstdint>

class HcalElectronicsId {
public:
  constexpr HcalElectronicsId() 
    : hcalElectronicsId_{0xffffffffu}
  {}
  constexpr HcalElectronicsId(uint32_t id)
    : hcalElectronicsId_{id}
  {}
  constexpr HcalElectronicsId(int fiberChan, int fiberIndex, int spigot, int dccid)
    : hcalElectronicsId_((uint32_t)((fiberChan&0x3) | (((fiberIndex-1)&0x7)<<2) |
      ((spigot&0xF)<<5) | ((dccid&0x1F)<<9)))
  {}
  constexpr HcalElectronicsId(int slbChan, int slbSite, int spigot, 
                              int dccid, int crate, int slot, int tb) 
    : hcalElectronicsId_((uint32_t)((slbChan&0x3) | (((slbSite)&0x7)<<2) |
      ((spigot&0xF)<<5) | ((dccid&0x1F)<<9))) {
    hcalElectronicsId_|=((tb&0x1)<<19) | ((slot&0x1f)<<14) | ((crate&0x3f)<<20);
    hcalElectronicsId_|=0x02000000;
  }
  constexpr HcalElectronicsId(int crate, int slot, int fiber, int fc, bool isTrigger) 
    : hcalElectronicsId_((int)((fc&0xF) | (((fiber)&0x1F)<<4) |
      ((slot&0xF)<<9) | ((crate&0x3F)<<13))) {
    if (isTrigger)   hcalElectronicsId_|=0x02000000;
    hcalElectronicsId_|=0x04000000;
  }

  constexpr uint32_t operator()() { return hcalElectronicsId_; }

  constexpr uint32_t rawId() const { return hcalElectronicsId_; }

  constexpr bool isVMEid() const { return (hcalElectronicsId_&0x04000000)==0; }
  constexpr bool isUTCAid() const { return (hcalElectronicsId_&0x04000000)!=0; }
  constexpr bool isTriggerChainId() const { return (hcalElectronicsId_&0x02000000)!=0; }

  constexpr void setHTR(int crate, int slot, int tb) {
    if (isUTCAid()) return; // cannot do this for uTCA
    hcalElectronicsId_&=0x3FFF; // keep the readout chain info
    hcalElectronicsId_|=((tb&0x1)<<19) | ((slot&0x1f)<<14) | ((crate&0x3f)<<20);
  }

  constexpr int subtype() const { return (isUTCAid())?((hcalElectronicsId_>>21)&0x1F):(-1); }
  constexpr int fiberChanId() const { return (isVMEid())?(hcalElectronicsId_&0x3):(hcalElectronicsId_&0xF); }
  constexpr int fiberIndex() const { return (isVMEid())?(((hcalElectronicsId_>>2)&0x7)+1):((hcalElectronicsId_>>4)&0x1F); }
  constexpr int slbChannelIndex() const { return hcalElectronicsId_&0x3; }
  constexpr int slbSiteNumber() const { return ((hcalElectronicsId_>>2)&0x7); }
 
  constexpr int htrChanId() const { return isVMEid()?((fiberChanId()+1)+((fiberIndex()-1)*3)):(0); }

  std::string slbChannelCode() const;

  constexpr int spigot() const { return (isVMEid())?((hcalElectronicsId_>>5)&0xF):slot(); }
  constexpr int dccid() const { return (isVMEid())?((hcalElectronicsId_>>9)&0x1F):crateId(); }
  constexpr int htrSlot() const { return slot(); }
  constexpr int slot() const { return (isVMEid())?((hcalElectronicsId_>>14)&0x1F):((hcalElectronicsId_>>9)&0xF); }
  constexpr int htrTopBottom() const { return (isVMEid())?((hcalElectronicsId_>>19)&0x1):(-1); }
  constexpr int readoutVMECrateId() const { return crateId(); }
  constexpr int crateId() const { return (isVMEid())?((hcalElectronicsId_>>20)&0x1F):((hcalElectronicsId_>>13)&0x3F); }
  constexpr int linearIndex() const { return (isVMEid())?((hcalElectronicsId_)&0x3FFF):((hcalElectronicsId_)&0x7FFFF); }

  static const int maxLinearIndex = 0x7FFFF; // 
  static const int maxDCCId = 31;
  
  constexpr int operator==(const HcalElectronicsId& id) const { return id.hcalElectronicsId_==hcalElectronicsId_; }
  constexpr int operator!=(const HcalElectronicsId& id) const { return id.hcalElectronicsId_!=hcalElectronicsId_; }
  constexpr int operator<(const HcalElectronicsId& id) const { return hcalElectronicsId_<id.hcalElectronicsId_; }

private:
  uint32_t hcalElectronicsId_;
};

std::ostream& operator<<(std::ostream&,const HcalElectronicsId&);


#endif