HGCalTriggerBackendDetId.h

Go to the documentation of this file.

#ifndef DataFormats_ForwardDetId_HGCalTriggerBackendDetId_H
#define DataFormats_ForwardDetId_HGCalTriggerBackendDetId_H 1

#include "DataFormats/DetId/interface/DetId.h"
#include "DataFormats/ForwardDetId/interface/HGCalTriggerBackendCommon.h"
#include "DataFormats/ForwardDetId/interface/ForwardSubdetector.h"

/* \brief description of the bit assigment
   [0:10]  ID of the lpGBT or Stage 1 FPGA in sector 0 
   [11:12] sector (0,1,2 counter-clockwise from u-axis)
   [13:15] Type (0 lpGBT
                 1 Stage 1 FPGA
                 2 Stage 1 link
                 3 Stage 2 FPGA)
   [16:16] z-side (0 for +z; 1 for -z)
   [19:23] reserved for future use
   [24:24] Class identifier (0 for HGCalTriggerModuleDetID, 1 for HGCalTriggerBackendDetID)
   [25:27] Subdetector Type (HGCTrigger)
   [28:31] Detector type (Forward)
*/

class HGCalTriggerBackendDetId : public DetId {
public:
  HGCalTriggerBackendDetId();
  HGCalTriggerBackendDetId(uint32_t rawid);
  HGCalTriggerBackendDetId(int zp, int type, int sector, int label);
  HGCalTriggerBackendDetId(const DetId& id);
  HGCalTriggerBackendDetId& operator=(const DetId& id);

  int classId() const { return (id_ >> kHGCalTriggerClassIdentifierOffset) & kHGCalTriggerClassIdentifierMask; }

  int type() const { return (id_ >> kHGCalTypeOffset) & kHGCalTypeMask; }

  int zside() const { return ((id_ >> kHGCalZsideOffset) & kHGCalZsideMask ? -1 : 1); }

  int sector() const { return (id_ >> kHGCalSectorOffset) & kHGCalSectorMask; }

  int label() const { return (id_ >> kHGCalLabelOffset) & kHGCalLabelMask; }

  bool isLpGBT() const { return (type() == BackendType::LpGBT); }
  bool isStage1FPGA() const { return (type() == BackendType::Stage1FPGA); }
  bool isStage1Link() const { return (type() == BackendType::Stage1Link); }
  bool isStage2FPGA() const { return (type() == BackendType::Stage2FPGA); }
  bool isForward() const { return true; }
  bool isHGCalModuleDetId() const { return (classId() == HGCalTriggerClassIdentifier::ModuleDetId); }
  bool isHGCalBackendDetId() const { return (classId() == HGCalTriggerClassIdentifier::BackendDetId); }

  static const HGCalTriggerBackendDetId Undefined;

  static const int kHGCalLabelOffset = 0;
  static const int kHGCalLabelMask = 0x7FF;
  static const int kHGCalSectorOffset = 11;
  static const int kHGCalSectorMask = 0x3;
  static const int kHGCalTypeOffset = 13;
  static const int kHGCalTypeMask = 0x7;
  static const int kHGCalZsideOffset = 16;
  static const int kHGCalZsideMask = 0x1;
  static const int kHGCalTriggerClassIdentifierOffset = 24;
  static const int kHGCalTriggerClassIdentifierMask = 0x1;

  enum BackendType { LpGBT, Stage1FPGA, Stage1Link, Stage2FPGA };
};

std::ostream& operator<<(std::ostream&, const HGCalTriggerBackendDetId& id);

#endif