HcalDcsDetId Class Reference

#include <HcalDcsDetId.h>

Inheritance diagram for HcalDcsDetId:

Public Types
enum	DcsType {   HV = 1, BV = 2, CATH = 3, DYN7 = 4,   DYN8 = 5, RM_TEMP = 6, CCM_TEMP = 7, CALIB_TEMP = 8,   LVTTM_TEMP = 9, TEMP = 10, QPLL_LOCK = 11, STATUS = 12,   DCSUNKNOWN = 15, DCS_MAX = 16 }
Public Types inherited from DetId
enum	Detector {   Tracker = 1, Muon = 2, Ecal = 3, Hcal = 4,   Calo = 5, Forward = 6, VeryForward = 7, HGCalEE = 8,   HGCalHSi = 9, HGCalHSc = 10, HGCalTrigger = 11 }

Public Member Functions
	HcalDcsDetId ()
	HcalDcsDetId (uint32_t rawid)
	HcalDcsDetId (const DetId &id)
	HcalDcsDetId (HcalOtherSubdetector subd, int side_or_ring, unsigned int slc, DcsType ty, unsigned int subchan)
int	ring () const
int	slice () const
int	subchannel () const
DcsType	type () const
int	zside () const
Public Member Functions inherited from HcalOtherDetId
	HcalOtherDetId (const DetId &id)
HcalOtherDetId &	operator= (const DetId &id)
HcalOtherSubdetector	subdet () const
	get the category More...
Public Member Functions inherited from DetId
constexpr Detector	det () const
	get the detector field from this detid More...
constexpr	DetId ()
	Create an empty or null id (also for persistence) More...
constexpr	DetId (uint32_t id)
	Create an id from a raw number. More...
constexpr	DetId (Detector det, int subdet)
	Create an id, filling the detector and subdetector fields as specified. More...
constexpr bool	null () const
	is this a null id ? More...
constexpr	operator uint32_t () const
constexpr bool	operator!= (DetId id) const
	inequality More...
constexpr uint32_t	operator() () const
constexpr bool	operator< (DetId id) const
	comparison More...
constexpr bool	operator== (DetId id) const
	equality More...
constexpr uint32_t	rawId () const
	get the raw id More...
constexpr int	subdetId () const
	get the contents of the subdetector field (not cast into any detector's numbering enum) More...

Static Public Member Functions
static DcsType	DcsTypeFromString (const std::string &str)
static std::string	typeString (DcsType typ)

Static Public Attributes
static const int	maxLinearIndex = 0x16800
Static Public Attributes inherited from DetId
static const int	kDetMask = 0xF
static const int	kDetOffset = 28
static const int	kSubdetMask = 0x7
static const int	kSubdetOffset = 25

Static Protected Attributes
static unsigned int const	kRingOffset = 17
static unsigned int const	kSideOffset = 19
static unsigned int const	kSliceOffset = 12
static unsigned int const	kSubChannelOffset = 4
static unsigned int const	kTypeOffset = 8

Additional Inherited Members
Protected Member Functions inherited from HcalOtherDetId
	HcalOtherDetId ()
	HcalOtherDetId (uint32_t rawid)
	HcalOtherDetId (HcalOtherSubdetector subdet)
	Constructor from signed ieta, iphi plus composite type and composite data. More...
Protected Attributes inherited from DetId
uint32_t	id_

Detailed Description

for use to identify HcalDcsChannels

bit packing [31:28] from DetId to identify detector (Hcal) [27:25] from DetId to identify subdetector (HcalOther) [24:20] other subdet id [19:19] zside +/- [18:17] HO ring (not important in other subdets) [16:12] Slice (phi slice for HB HE, Sector for HO, Quadrant for HF) [11:8] Type from the DCSType list [7:4] sub-channel a number to identify the channel can be from 0 to 15 [3:0] still open

Definition at line 27 of file HcalDcsDetId.h.

Member Enumeration Documentation

enum HcalDcsDetId::DcsType

Enumerator
HV
BV
CATH
DYN7
DYN8
RM_TEMP
CCM_TEMP
CALIB_TEMP
LVTTM_TEMP
TEMP
QPLL_LOCK
STATUS
DCSUNKNOWN
DCS_MAX

Definition at line 29 of file HcalDcsDetId.h.

               {
    HV = 1,
    BV = 2,
    CATH = 3,
    DYN7 = 4,
    DYN8 = 5,
    RM_TEMP = 6,
    CCM_TEMP = 7,
    CALIB_TEMP = 8,
    LVTTM_TEMP = 9,
    TEMP = 10,
    QPLL_LOCK = 11,
    STATUS = 12,
    DCSUNKNOWN = 15,
    DCS_MAX = 16
  };

Constructor & Destructor Documentation

HcalDcsDetId::HcalDcsDetId

(

)

Definition at line 5 of file HcalDcsDetId.cc.

: HcalOtherDetId() {}

HcalDcsDetId::HcalDcsDetId

(

uint32_t

rawid

)

Definition at line 7 of file HcalDcsDetId.cc.

: HcalOtherDetId(rawid) {}

HcalDcsDetId::HcalDcsDetId

(

const DetId &

id

)

Definition at line 9 of file HcalDcsDetId.cc.

References TauDecayModes::dec, Exception, HcalDcsBarrel, HcalDcsEndcap, HcalDcsForward, HcalDcsOuter, DetId::id_, and HcalOtherDetId::subdet().

                                          : HcalOtherDetId(id) {
  if ((subdet() != HcalDcsBarrel) || (subdet() != HcalDcsEndcap) || (subdet() != HcalDcsOuter) ||
      (subdet() != HcalDcsForward)) {
    throw cms::Exception("Invalid DetId") << "Cannot intialize HcalDcsDetId from " << std::hex << id_ << std::dec;
  }
}

HcalDcsDetId::HcalDcsDetId	(	HcalOtherSubdetector	subd,
		int	side_or_ring,
		unsigned int	slc,
		DcsType	ty,
		unsigned int	subchan
	)

Definition at line 16 of file HcalDcsDetId.cc.

References DetId::id_, kRingOffset, kSideOffset, kSliceOffset, kSubChannelOffset, and kTypeOffset.

    : HcalOtherDetId(subd) {
  id_ |= ((side_or_ring > 0) ? ((1 << kSideOffset) | (side_or_ring << kRingOffset)) : ((-side_or_ring) << kRingOffset));
  id_ |= (slc & 0x1F) << kSliceOffset;
  id_ |= (ty & 0xF) << kTypeOffset;
  id_ |= (subchan & 0xF) << kSubChannelOffset;
}

Member Function Documentation

HcalDcsDetId::DcsType HcalDcsDetId::DcsTypeFromString ( const std::string &  str )

static

Definition at line 25 of file HcalDcsDetId.cc.

References DCS_MAX, DCSUNKNOWN, HV, and typeString().

                                                                        {
  int ty(HV);
  do {
    if (typeString(HcalDcsDetId::DcsType(ty)) == str)
      return HcalDcsDetId::DcsType(ty);
  } while (++ty != DCS_MAX);
  return DCSUNKNOWN;
}

int HcalDcsDetId::ring ( ) const

inline

Definition at line 55 of file HcalDcsDetId.h.

References DetId::id_, kRingOffset, and zside().

Referenced by HcalDcsValues::exists(), HcalDcsValues::getValues(), geometryXMLparser.CSCAlignable::index(), HcalDcsMap::lookup(), and HcalDcsMapAddons::Helper::mapGeomId2DcsId().

{ return zside() * ((id_ >> kRingOffset) & 0x3); }

int HcalDcsDetId::slice ( ) const

inline

Definition at line 56 of file HcalDcsDetId.h.

References DetId::id_, and kSliceOffset.

Referenced by HcalDcsMap::lookup(), and HcalDcsMapAddons::Helper::mapGeomId2DcsId().

{ return ((id_ >> kSliceOffset) & 0x1F); }

int HcalDcsDetId::subchannel ( ) const

inline

Definition at line 58 of file HcalDcsDetId.h.

References DetId::id_, and kSubChannelOffset.

Referenced by HcalDcsMap::lookup(), and HcalDcsMapAddons::Helper::mapGeomId2DcsId().

{ return ((id_ >> kSubChannelOffset) & 0xF); }

DcsType HcalDcsDetId::type ( ) const

inline

Definition at line 57 of file HcalDcsDetId.h.

References DetId::id_, and kTypeOffset.

{ return DcsType((id_ >> kTypeOffset) & 0xF); }

std::string HcalDcsDetId::typeString ( DcsType  typ )

static

Definition at line 34 of file HcalDcsDetId.cc.

References BV, CALIB_TEMP, CATH, CCM_TEMP, DYN7, DYN8, HV, LVTTM_TEMP, QPLL_LOCK, RM_TEMP, STATUS, and TEMP.

Referenced by DcsTypeFromString().

                                              {
  switch (typ) {
    case HV:
      return "HV";
    case BV:
      return "BV";
    case CATH:
      return "CATH";
    case DYN7:
      return "DYN7";
    case DYN8:
      return "DYN8";
    case RM_TEMP:
      return "RM_TEMP";
    case CCM_TEMP:
      return "CCM_TEMP";
    case CALIB_TEMP:
      return "CALIB_TEMP";
    case LVTTM_TEMP:
      return "LVTTM_TEMP";
    case TEMP:
      return "TEMP";
    case QPLL_LOCK:
      return "QPLL_LOCK";
    case STATUS:
      return "STATUS";
    default:
      return "DCSUNKNOWN";
  }
  return "Invalid";
}

int HcalDcsDetId::zside ( ) const

inline

Definition at line 54 of file HcalDcsDetId.h.

References DetId::id_, and kSideOffset.

Referenced by ring().

{ return (((id_ >> kSideOffset) & 0x1) ? 1 : -1); }

Member Data Documentation

unsigned int const HcalDcsDetId::kRingOffset = 17

staticprotected

Definition at line 64 of file HcalDcsDetId.h.

Referenced by HcalDcsDetId(), and ring().

unsigned int const HcalDcsDetId::kSideOffset = 19

staticprotected

Definition at line 63 of file HcalDcsDetId.h.

Referenced by HcalDcsDetId(), and zside().

unsigned int const HcalDcsDetId::kSliceOffset = 12

staticprotected

Definition at line 65 of file HcalDcsDetId.h.

Referenced by HcalDcsDetId(), and slice().

unsigned int const HcalDcsDetId::kSubChannelOffset = 4

staticprotected

Definition at line 67 of file HcalDcsDetId.h.

Referenced by HcalDcsDetId(), and subchannel().

unsigned int const HcalDcsDetId::kTypeOffset = 8

staticprotected

Definition at line 66 of file HcalDcsDetId.h.

Referenced by HcalDcsDetId(), and type().

const int HcalDcsDetId::maxLinearIndex = 0x16800

static

Definition at line 60 of file HcalDcsDetId.h.