CMS 3D CMS Logo

List of all members | Public Member Functions | Protected Types | Static Protected Attributes
MTDDetId Class Reference

Detector identifier base class for the MIP Timing Layer. More...

#include <MTDDetId.h>

Inheritance diagram for MTDDetId:
DetId BTLDetId ETLDetId

Public Member Functions

 MTDDetId ()
 
 MTDDetId (const uint32_t &raw_id)
 
 MTDDetId (const DetId &det_id)
 
 MTDDetId (Detector det, int subdet)
 
int mtdRR () const
 
int mtdSide () const
 
int mtdSubDetector () const
 
SubDetector subDetector () const
 
- 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...
 

Protected Types

enum  MTDType { typeUNKNOWN =0, BTL =1, ETL =2 }
 
enum  SubDetector { subUNKNOWN =0, FastTime =1 }
 

Static Protected Attributes

static const uint32_t kMTDsubdMask = 0x3
 
static const uint32_t kMTDsubdOffset = 23
 
static const uint32_t kRodRingMask = 0x3F
 
static const uint32_t kRodRingOffset = 16
 
static const uint32_t kZsideMask = 0x1
 
static const uint32_t kZsideOffset = 22
 

Additional Inherited Members

- 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
}
 
- 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
 
- Protected Attributes inherited from DetId
uint32_t id_
 

Detailed Description

Detector identifier base class for the MIP Timing Layer.

bit 31-28: Detector Forward bit 27-25: Subdetctor FastTiming

bit 24-23: MTD subdetector BTL/ETL bit 22 : side (positive = 1, negative = 0) bit 21-16: rod/ring sequential number

Definition at line 21 of file MTDDetId.h.

Member Enumeration Documentation

enum MTDDetId::MTDType
protected

Enumerated type for MTD sub-deteector systems.

Enumerator
typeUNKNOWN 
BTL 
ETL 

Definition at line 29 of file MTDDetId.h.

enum MTDDetId::SubDetector
protected

Enumerated type for Forward sub-deteector systems.

Enumerator
subUNKNOWN 
FastTime 

Definition at line 26 of file MTDDetId.h.

Constructor & Destructor Documentation

MTDDetId::MTDDetId ( )
inline

Construct a null id

Definition at line 43 of file MTDDetId.h.

43 : DetId() {;}
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:30
MTDDetId::MTDDetId ( const uint32_t &  raw_id)
inline

Construct from a raw value

Definition at line 46 of file MTDDetId.h.

46 : DetId( raw_id ) {;}
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:30
MTDDetId::MTDDetId ( const DetId det_id)
inline

Construct from generic DetId

Definition at line 49 of file MTDDetId.h.

49 : DetId( det_id.rawId() ) {;}
constexpr uint32_t rawId() const
get the raw id
Definition: DetId.h:47
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:30
MTDDetId::MTDDetId ( Detector  det,
int  subdet 
)
inline

Construct and fill only the det and sub-det fields.

Definition at line 52 of file MTDDetId.h.

52 : DetId( det, subdet ) {;}
constexpr DetId()
Create an empty or null id (also for persistence)
Definition: DetId.h:30
constexpr Detector det() const
get the detector field from this detid
Definition: DetId.h:39

Member Function Documentation

int MTDDetId::mtdRR ( ) const
inline

Returns MTD rod/ring number.

Definition at line 66 of file MTDDetId.h.

References DetId::id_, kRodRingMask, and operator<<().

66 { return (id_>>kRodRingOffset)&kRodRingMask; }
static const uint32_t kRodRingOffset
Definition: MTDDetId.h:35
static const uint32_t kRodRingMask
Definition: MTDDetId.h:36
uint32_t id_
Definition: DetId.h:59
int MTDDetId::mtdSide ( ) const
inline

Returns MTD side, i.e. Z-=1 or Z+=2.

Definition at line 63 of file MTDDetId.h.

References DetId::id_, and kZsideMask.

63 { return (id_>>kZsideOffset)&kZsideMask; }
static const uint32_t kZsideOffset
Definition: MTDDetId.h:33
static const uint32_t kZsideMask
Definition: MTDDetId.h:34
uint32_t id_
Definition: DetId.h:59
int MTDDetId::mtdSubDetector ( ) const
inline

Returns enumerated type specifying MTD sub-detector, i.e. BTL or ETL.

Definition at line 60 of file MTDDetId.h.

References DetId::id_, and kMTDsubdMask.

60 { return (id_>>kMTDsubdOffset)&kMTDsubdMask; }
static const uint32_t kMTDsubdOffset
Definition: MTDDetId.h:31
static const uint32_t kMTDsubdMask
Definition: MTDDetId.h:32
uint32_t id_
Definition: DetId.h:59
SubDetector MTDDetId::subDetector ( ) const
inline

Returns enumerated type specifying MTD sub-detector.

Definition at line 57 of file MTDDetId.h.

References DetId::subdetId().

57 { return static_cast<MTDDetId::SubDetector>(subdetId()); }
constexpr int subdetId() const
get the contents of the subdetector field (not cast into any detector&#39;s numbering enum) ...
Definition: DetId.h:41
SubDetector
Definition: MTDDetId.h:26

Member Data Documentation

const uint32_t MTDDetId::kMTDsubdMask = 0x3
staticprotected

Definition at line 32 of file MTDDetId.h.

Referenced by BTLDetId::BTLDetId(), ETLDetId::ETLDetId(), and mtdSubDetector().

const uint32_t MTDDetId::kMTDsubdOffset = 23
staticprotected

Definition at line 31 of file MTDDetId.h.

Referenced by BTLDetId::BTLDetId(), and ETLDetId::ETLDetId().

const uint32_t MTDDetId::kRodRingMask = 0x3F
staticprotected

Definition at line 36 of file MTDDetId.h.

Referenced by BTLDetId::BTLDetId(), ETLDetId::ETLDetId(), and mtdRR().

const uint32_t MTDDetId::kRodRingOffset = 16
staticprotected

Definition at line 35 of file MTDDetId.h.

Referenced by BTLDetId::BTLDetId(), and ETLDetId::ETLDetId().

const uint32_t MTDDetId::kZsideMask = 0x1
staticprotected

Definition at line 34 of file MTDDetId.h.

Referenced by BTLDetId::BTLDetId(), ETLDetId::ETLDetId(), and mtdSide().

const uint32_t MTDDetId::kZsideOffset = 22
staticprotected

Definition at line 33 of file MTDDetId.h.

Referenced by BTLDetId::BTLDetId(), and ETLDetId::ETLDetId().