HcalElectronicsId Class Reference

Readout chain identification for Hcal. More...

#include <HcalElectronicsId.h>

Public Member Functions
constexpr int	crateId () const
	get the readout VME crate number More...
constexpr int	dccid () const
	get the (Hcal local) DCC id for VME, crate number for uTCA More...
constexpr int	fiberChanId () const
	get the fiber channel id (which of channels on a fiber) More...
constexpr int	fiberIndex () const
	get the fiber index. For VME 1-8 (which of eight fibers carried by a spigot), for uTCA fibers are zero-based More...
constexpr	HcalElectronicsId ()
constexpr	HcalElectronicsId (int crate, int slot, int fiber, int fc, bool isTrigger)
constexpr	HcalElectronicsId (int fiberChan, int fiberIndex, int spigot, int dccid)
constexpr	HcalElectronicsId (int slbChan, int slbSite, int spigot, int dccid, int crate, int slot, int tb)
constexpr	HcalElectronicsId (uint32_t id)
constexpr int	htrChanId () const
	get the HTR channel id (1-24) More...
constexpr int	htrSlot () const
	get the htr slot More...
constexpr int	htrTopBottom () const
	get the htr top/bottom (1=top/0=bottom), valid for VME More...
constexpr bool	isTriggerChainId () const
constexpr bool	isUTCAid () const
constexpr bool	isVMEid () const
constexpr int	linearIndex () const
	get a fast, compact, unique index for linear lookups More...
constexpr int	operator!= (const HcalElectronicsId &id) const
constexpr uint32_t	operator() ()
constexpr int	operator< (const HcalElectronicsId &id) const
	Compare the id to another id for use in a map. More...
constexpr int	operator== (const HcalElectronicsId &id) const
constexpr uint32_t	rawId () const
constexpr int	readoutVMECrateId () const
	get the readout VME crate number More...
constexpr void	setHTR (int crate, int slot, int tb)
std::string	slbChannelCode () const
	get the HTR-wide slb channel code (letter plus number) More...
constexpr int	slbChannelIndex () const
	get the SLB channel index (valid only for VME trigger-chain ids) More...
constexpr int	slbSiteNumber () const
	get the SLB site number (valid only for VME trigger-chain ids) More...
constexpr int	slot () const
	get the htr or uHTR slot More...
constexpr int	spigot () const
	get the spigot (input number on DCC, AMC card number for uTCA) More...
constexpr int	subtype () const
	get subtype for this channel (valid for uTCA only) More...

Static Public Attributes
static const int	maxDCCId = 31
static const int	maxLinearIndex = 0x7FFFF

Private Attributes
uint32_t	hcalElectronicsId_

Detailed Description

Readout chain identification for Hcal.

[31:27] Unused (so far) [26] VME (0), uTCA (1)

For VME Electronics: [25] Trigger-chain id flag [24:20] Readout Crate Id [19] HTR FPGA selector [t/b] [18:14] HTR Slot [13:9] DCC id [8:5] Spigot [4:2] FiberIndex or SLB site [1:0] FiberChanId or SLB channel

For uTCA Electronics:

[25] Is Trigger Id [18:13] Readout Crate Id [12:9] Slot [8:4] Fiber [3:0] FiberChanId

Definition at line 32 of file HcalElectronicsId.h.

Constructor & Destructor Documentation

HcalElectronicsId() [1/5]

constexpr HcalElectronicsId::HcalElectronicsId ( )

inlineconstexpr

Default constructor – invalid value

Definition at line 35 of file HcalElectronicsId.h.

: hcalElectronicsId_{0xffffffffu} {}

HcalElectronicsId() [2/5]

constexpr HcalElectronicsId::HcalElectronicsId ( uint32_t  id )

inlineconstexpr

from raw

Definition at line 37 of file HcalElectronicsId.h.

: hcalElectronicsId_{id} {}

HcalElectronicsId() [3/5]

constexpr HcalElectronicsId::HcalElectronicsId ( int  fiberChan, int  fiberIndex, int  spigot, int  dccid  )

inlineconstexpr

VME Constructor from fiberchan,fiber index,spigot,dccid

Definition at line 39 of file HcalElectronicsId.h.

      : hcalElectronicsId_((uint32_t)((fiberChan & 0x3) | (((fiberIndex - 1) & 0x7) << 2) | ((spigot & 0xF) << 5) |
                                      ((dccid & 0x1F) << 9))) {}

HcalElectronicsId() [4/5]

constexpr HcalElectronicsId::HcalElectronicsId ( int  slbChan, int  slbSite, int  spigot, int  dccid, int  crate, int  slot, int  tb  )

inlineconstexpr

VME Constructor from slb channel,slb site,spigot,dccid

Definition at line 43 of file HcalElectronicsId.h.

      : 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;
  }

References hcalElectronicsId_, and slot().

HcalElectronicsId() [5/5]

constexpr HcalElectronicsId::HcalElectronicsId ( int  crate, int  slot, int  fiber, int  fc, bool  isTrigger  )

inlineconstexpr

uTCA constructor

Definition at line 50 of file HcalElectronicsId.h.

      : hcalElectronicsId_((int)((fc & 0xF) | (((fiber)&0x1F) << 4) | ((slot & 0xF) << 9) | ((crate & 0x3F) << 13))) {
    if (isTrigger)
      hcalElectronicsId_ |= 0x02000000;
    hcalElectronicsId_ |= 0x04000000;
  }

References hcalElectronicsId_.

Member Function Documentation

crateId()

constexpr int HcalElectronicsId::crateId ( ) const

inlineconstexpr

get the readout VME crate number

Definition at line 107 of file HcalElectronicsId.h.

                                {
    return (isVMEid()) ? ((hcalElectronicsId_ >> 20) & 0x1F) : ((hcalElectronicsId_ >> 13) & 0x3F);
  }

References hcalElectronicsId_, and isVMEid().

Referenced by dccid(), hcaldqm::quantity::getEid_FEDuTCASlot(), and readoutVMECrateId().

dccid()

constexpr int HcalElectronicsId::dccid ( ) const

inlineconstexpr

get the (Hcal local) DCC id for VME, crate number for uTCA

Definition at line 95 of file HcalElectronicsId.h.

{ return (isVMEid()) ? ((hcalElectronicsId_ >> 9) & 0x1F) : crateId(); }

References crateId(), hcalElectronicsId_, and isVMEid().

Referenced by HtrXmlPatternTool::Fill(), CMTRawAnalyzer::fillMAP(), hcaldqm::quantity::getEid_FEDVMESpigot(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), HTLogicalMapEntry::printLMapLine(), and SelectedElectronFEDListProducer< TEle, TCand >::produce().

fiberChanId()

constexpr int HcalElectronicsId::fiberChanId ( ) const

inlineconstexpr

get the fiber channel id (which of channels on a fiber)

Definition at line 76 of file HcalElectronicsId.h.

{ return (isVMEid()) ? (hcalElectronicsId_ & 0x3) : (hcalElectronicsId_ & 0xF); }

References hcalElectronicsId_, and isVMEid().

Referenced by hcaldqm::quantity::getEid_FiberuTCAFiberCh(), hcaldqm::quantity::getEid_FiberuTCATPFiberChuTCATP(), hcaldqm::quantity::getEid_FiberVMEFiberCh(), htrChanId(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), HcalLedAnalysis::processLedEvent(), and SelectedElectronFEDListProducer< TEle, TCand >::produce().

fiberIndex()

constexpr int HcalElectronicsId::fiberIndex ( ) const

inlineconstexpr

get the fiber index. For VME 1-8 (which of eight fibers carried by a spigot), for uTCA fibers are zero-based

Definition at line 78 of file HcalElectronicsId.h.

                                   {
    return (isVMEid()) ? (((hcalElectronicsId_ >> 2) & 0x7) + 1) : ((hcalElectronicsId_ >> 4) & 0x1F);
  }

References hcalElectronicsId_, and isVMEid().

Referenced by CMTRawAnalyzer::fillMAP(), hcaldqm::quantity::getEid_FiberuTCAFiberCh(), hcaldqm::quantity::getEid_FiberuTCATPFiberChuTCATP(), hcaldqm::quantity::getEid_FiberVMEFiberCh(), htrChanId(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), and SelectedElectronFEDListProducer< TEle, TCand >::produce().

htrChanId()

constexpr int HcalElectronicsId::htrChanId ( ) const

inlineconstexpr

get the HTR channel id (1-24)

Definition at line 87 of file HcalElectronicsId.h.

{ return isVMEid() ? ((fiberChanId() + 1) + ((fiberIndex() - 1) * 3)) : (0); }

References fiberChanId(), fiberIndex(), and isVMEid().

Referenced by HtrXmlPatternTool::Fill().

htrSlot()

constexpr int HcalElectronicsId::htrSlot ( ) const

inlineconstexpr

get the htr slot

Definition at line 97 of file HcalElectronicsId.h.

{ return slot(); }

References slot().

Referenced by HtrXmlPatternTool::Fill(), CMTRawAnalyzer::fillMAP(), HcalPacker::pack(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), and HTLogicalMapEntry::printLMapLine().

htrTopBottom()

constexpr int HcalElectronicsId::htrTopBottom ( ) const

inlineconstexpr

get the htr top/bottom (1=top/0=bottom), valid for VME

Definition at line 103 of file HcalElectronicsId.h.

{ return (isVMEid()) ? ((hcalElectronicsId_ >> 19) & 0x1) : (-1); }

References hcalElectronicsId_, isVMEid(), and testProducerWithPsetDescEmpty_cfi::x1.

Referenced by HtrXmlPatternTool::Fill(), CMTRawAnalyzer::fillMAP(), HcalPacker::pack(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), HTLogicalMapEntry::printLMapLine(), and slbChannelCode().

isTriggerChainId()

constexpr bool HcalElectronicsId::isTriggerChainId ( ) const

inlineconstexpr

Definition at line 63 of file HcalElectronicsId.h.

{ return (hcalElectronicsId_ & 0x02000000) != 0; }

References hcalElectronicsId_.

Referenced by slbChannelCode().

isUTCAid()

constexpr bool HcalElectronicsId::isUTCAid ( ) const

inlineconstexpr

Definition at line 62 of file HcalElectronicsId.h.

{ return (hcalElectronicsId_ & 0x04000000) != 0; }

References hcalElectronicsId_.

Referenced by setHTR(), and subtype().

isVMEid()

constexpr bool HcalElectronicsId::isVMEid ( ) const

inlineconstexpr

Definition at line 61 of file HcalElectronicsId.h.

{ return (hcalElectronicsId_ & 0x04000000) == 0; }

References hcalElectronicsId_.

Referenced by crateId(), dccid(), fiberChanId(), fiberIndex(), htrChanId(), htrTopBottom(), linearIndex(), slbChannelCode(), slot(), and spigot().

linearIndex()

constexpr int HcalElectronicsId::linearIndex ( ) const

inlineconstexpr

get a fast, compact, unique index for linear lookups

Definition at line 111 of file HcalElectronicsId.h.

                                    {
    return (isVMEid()) ? ((hcalElectronicsId_)&0x3FFF) : ((hcalElectronicsId_)&0x7FFFF);
  }

References hcalElectronicsId_, and isVMEid().

Referenced by HBHEHFLogicalMapEntry::getHcalElectronicsId(), HOHXLogicalMapEntry::getHcalElectronicsId(), CALIBLogicalMapEntry::getHcalElectronicsId(), ZDCLogicalMapEntry::getHcalElectronicsId(), HTLogicalMapEntry::getHcalTrigElectronicsId(), HcalElectronicsMap::lookup(), HcalElectronicsMapAddons::Helper::mapEId2chId(), and HcalElectronicsMapAddons::Helper::mapEId2tId().

operator!=()

constexpr int HcalElectronicsId::operator!= ( const HcalElectronicsId &  id ) const

inlineconstexpr

Non-Equality operator

Definition at line 121 of file HcalElectronicsId.h.

{ return id.hcalElectronicsId_ != hcalElectronicsId_; }

References hcalElectronicsId_.

operator()()

constexpr uint32_t HcalElectronicsId::operator() ( )

inlineconstexpr

Definition at line 57 of file HcalElectronicsId.h.

{ return hcalElectronicsId_; }

References hcalElectronicsId_.

operator<()

constexpr int HcalElectronicsId::operator< ( const HcalElectronicsId &  id ) const

inlineconstexpr

Compare the id to another id for use in a map.

Definition at line 123 of file HcalElectronicsId.h.

{ return hcalElectronicsId_ < id.hcalElectronicsId_; }

References hcalElectronicsId_.

operator==()

constexpr int HcalElectronicsId::operator== ( const HcalElectronicsId &  id ) const

inlineconstexpr

Equality operator

Definition at line 119 of file HcalElectronicsId.h.

{ return id.hcalElectronicsId_ == hcalElectronicsId_; }

References hcalElectronicsId_.

rawId()

constexpr uint32_t HcalElectronicsId::rawId ( ) const

inlineconstexpr

Definition at line 59 of file HcalElectronicsId.h.

{ return hcalElectronicsId_; }

References hcalElectronicsId_.

Referenced by hcaldqm::DQHarvester::beginRun(), hcaldqm::DQClient::beginRun(), PedestalTask::bookHistograms(), TPTask::bookHistograms(), LaserTask::bookHistograms(), RawTask::bookHistograms(), RecHitTask::bookHistograms(), DigiTask::bookHistograms(), hcaldqm::DQTask::bookHistograms(), CALIBLogicalMapEntry::CALIBLogicalMapEntry(), hcaldqm::hashfunctions::hash_Crate(), hcaldqm::hashfunctions::hash_CrateSlot(), hcaldqm::hashfunctions::hash_CrateSpigot(), hcaldqm::hashfunctions::hash_EChannel(), hcaldqm::hashfunctions::hash_Electronics(), hcaldqm::hashfunctions::hash_FED(), hcaldqm::hashfunctions::hash_FEDSlot(), hcaldqm::hashfunctions::hash_FEDSpigot(), hcaldqm::hashfunctions::hash_Fiber(), hcaldqm::hashfunctions::hash_FiberCh(), hcaldqm::hashfunctions::hash_FiberFiberCh(), HBHEHFLogicalMapEntry::HBHEHFLogicalMapEntry(), HOHXLogicalMapEntry::HOHXLogicalMapEntry(), HTLogicalMapEntry::HTLogicalMapEntry(), HcalElectronicsMap::lookup(), HcalElectronicsMap::lookupTrigger(), HcalElectronicsMapAddons::Helper::mapEId2chId(), HcalElectronicsMapAddons::Helper::mapEId2tId(), and ZDCLogicalMapEntry::ZDCLogicalMapEntry().

readoutVMECrateId()

constexpr int HcalElectronicsId::readoutVMECrateId ( ) const

inlineconstexpr

get the readout VME crate number

Definition at line 105 of file HcalElectronicsId.h.

{ return crateId(); }

References crateId().

Referenced by HtrXmlPatternTool::Fill(), CMTRawAnalyzer::fillMAP(), HcalLutManager::getLinearizationLutXmlFromAsciiMasterEmap_new(), HcalPacker::pack(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), and HTLogicalMapEntry::printLMapLine().

setHTR()

constexpr void HcalElectronicsId::setHTR ( int  crate, int  slot, int  tb  )

inlineconstexpr

Set the VME htr-related information 1=top, 0=bottom

Definition at line 66 of file HcalElectronicsId.h.

                                                     {
    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);
  }

References hcalElectronicsId_, isUTCAid(), and slot().

Referenced by CALIBLogicalMapEntry::CALIBLogicalMapEntry(), HcalDbASCIIIO::createObject< HcalElectronicsMap >(), ChannelPattern::Fill_by_hand(), HcalFiberPattern::getId(), HBHEHFLogicalMapEntry::HBHEHFLogicalMapEntry(), HOHXLogicalMapEntry::HOHXLogicalMapEntry(), and ZDCLogicalMapEntry::ZDCLogicalMapEntry().

slbChannelCode()

std::string HcalElectronicsId::slbChannelCode

(

)

const

get the HTR-wide slb channel code (letter plus number)

Definition at line 3 of file HcalElectronicsId.cc.

                                                  {
  std::string retval;
  if (isTriggerChainId() && isVMEid()) {
    if (htrTopBottom()) {  // top
      switch (slbChannelIndex()) {
        case (0):
          retval = "A0";
          break;
        case (1):
          retval = "A1";
          break;
        case (2):
          retval = "C0";
          break;
        case (3):
          retval = "C1";
          break;
      }
    } else {
      switch (slbChannelIndex()) {
        case (0):
          retval = "B0";
          break;
        case (1):
          retval = "B1";
          break;
        case (2):
          retval = "D0";
          break;
        case (3):
          retval = "D1";
          break;
      }
    }
  }
  return retval;
}

References htrTopBottom(), isTriggerChainId(), isVMEid(), slbChannelIndex(), and AlCaHLTBitMon_QueryRunRegistry::string.

slbChannelIndex()

constexpr int HcalElectronicsId::slbChannelIndex ( ) const

inlineconstexpr

get the SLB channel index (valid only for VME trigger-chain ids)

Definition at line 82 of file HcalElectronicsId.h.

{ return hcalElectronicsId_ & 0x3; }

References hcalElectronicsId_.

Referenced by hcaldqm::quantity::getEid_SLBSLBCh(), HTLogicalMapEntry::printLMapLine(), and slbChannelCode().

slbSiteNumber()

constexpr int HcalElectronicsId::slbSiteNumber ( ) const

inlineconstexpr

get the SLB site number (valid only for VME trigger-chain ids)

Definition at line 84 of file HcalElectronicsId.h.

{ return ((hcalElectronicsId_ >> 2) & 0x7); }

References hcalElectronicsId_.

Referenced by hcaldqm::quantity::getEid_SLBSLBCh(), and HTLogicalMapEntry::printLMapLine().

slot()

constexpr int HcalElectronicsId::slot ( ) const

inlineconstexpr

get the htr or uHTR slot

Definition at line 99 of file HcalElectronicsId.h.

                             {
    return (isVMEid()) ? ((hcalElectronicsId_ >> 14) & 0x1F) : ((hcalElectronicsId_ >> 9) & 0xF);
  }

References hcalElectronicsId_, and isVMEid().

Referenced by hcaldqm::quantity::getEid_FEDuTCASlot(), HcalElectronicsId(), htrSlot(), setHTR(), and spigot().

spigot()

constexpr int HcalElectronicsId::spigot ( ) const

inlineconstexpr

get the spigot (input number on DCC, AMC card number for uTCA)

Definition at line 93 of file HcalElectronicsId.h.

{ return (isVMEid()) ? ((hcalElectronicsId_ >> 5) & 0xF) : slot(); }

References hcalElectronicsId_, isVMEid(), and slot().

Referenced by HtrXmlPatternTool::Fill(), CMTRawAnalyzer::fillMAP(), hcaldqm::quantity::getEid_FEDVMESpigot(), HBHEHFLogicalMapEntry::printLMapLine(), HOHXLogicalMapEntry::printLMapLine(), CALIBLogicalMapEntry::printLMapLine(), ZDCLogicalMapEntry::printLMapLine(), HTLogicalMapEntry::printLMapLine(), and SelectedElectronFEDListProducer< TEle, TCand >::produce().

subtype()

constexpr int HcalElectronicsId::subtype ( ) const

inlineconstexpr

get subtype for this channel (valid for uTCA only)

Definition at line 74 of file HcalElectronicsId.h.

{ return (isUTCAid()) ? ((hcalElectronicsId_ >> 21) & 0x1F) : (-1); }

References hcalElectronicsId_, and isUTCAid().

Member Data Documentation

hcalElectronicsId_

uint32_t HcalElectronicsId::hcalElectronicsId_

private

Definition at line 126 of file HcalElectronicsId.h.

Referenced by crateId(), dccid(), fiberChanId(), fiberIndex(), HcalElectronicsId(), htrTopBottom(), isTriggerChainId(), isUTCAid(), isVMEid(), linearIndex(), operator!=(), operator()(), operator<(), operator==(), rawId(), setHTR(), slbChannelIndex(), slbSiteNumber(), slot(), spigot(), and subtype().

maxDCCId

const int HcalElectronicsId::maxDCCId = 31

static

Definition at line 116 of file HcalElectronicsId.h.

maxLinearIndex

const int HcalElectronicsId::maxLinearIndex = 0x7FFFF

static

Definition at line 115 of file HcalElectronicsId.h.

Referenced by HcalLogicalMapGenerator::createMap().