ldmx::HcalAbstractID Class Reference

Parent of HcalIDs. More...

#include <HcalAbstractID.h>

Public Types
enum	HcalBarType { Global = 0 , Digi = 1 , Trigger = 2 , Special = 7 }
	Encodes whether the side of the strips of the HCal is saved. More...
Public Types inherited from ldmx::DetectorID
typedef uint32_t	RawValue

Public Member Functions
	HcalAbstractID ()
	Empty HCAL id (but not null!)
	HcalAbstractID (RawValue rawid)
	Create from raw number.
	HcalAbstractID (const DetectorID id)
	Create from a DetectorID, but check.
	HcalAbstractID (unsigned int bar_type, unsigned int payload)
	Create from pieces.
int	bar_type () const
	Get the value of the bar field from the ID.
int	payload () const
	Get the value of the payload field from the ID.
Public Member Functions inherited from ldmx::DetectorID
	DetectorID ()
	Class constructor for a null DetectorID.
	DetectorID (RawValue rawid)
	Class constructor from a raw 32-bit integer.
	DetectorID (SubdetectorIDType sdtype, RawValue raw_subpayload)
	Class constructor from a subdetector id and a subdetector-specific section (masked to.
bool	null () const
SubdetectorIDType	subdet () const
RawValue	raw () const
void	setRawValue (RawValue rawValue)
	Set the raw value of the detector ID.
bool	operator< (const DetectorID &id) const
bool	operator== (const DetectorID &id) const
bool	operator!= (const DetectorID &id) const

Static Public Attributes
static const RawValue	BAR_TYPE_MASK {0x7}
static const RawValue	BAR_TYPE_SHIFT {23}
static const RawValue	HCAL_PAYLOAD_MASK {0x007FFFFF}
Static Public Attributes inherited from ldmx::DetectorID
static const RawValue	SUBDETECTORID_MASK {0x3F}
static const RawValue	SUBDETECTORID_SHIFT {26}
static const RawValue	SUBDETECTOR_PAYLOAD_MASK {0x3FFFFFF}

Additional Inherited Members
Protected Attributes inherited from ldmx::DetectorID
RawValue	id_
	The raw, packed value of the ID.

Detailed Description

Parent of HcalIDs.

Definition at line 20 of file HcalAbstractID.h.

Member Enumeration Documentation

HcalBarType

enum ldmx::HcalAbstractID::HcalBarType

Encodes whether the side of the strips of the HCal is saved.

Definition at line 25 of file HcalAbstractID.h.

                   {
    Global = 0,
    Digi = 1,
    Trigger = 2,
    Special = 7,
  };

Constructor & Destructor Documentation

HcalAbstractID() [1/4]

ldmx::HcalAbstractID::HcalAbstractID ( )

inline

Empty HCAL id (but not null!)

Definition at line 38 of file HcalAbstractID.h.

: DetectorID(SD_HCAL, 0) {}

HcalAbstractID() [2/4]

ldmx::HcalAbstractID::HcalAbstractID ( RawValue  rawid )

inline

Create from raw number.

Definition at line 43 of file HcalAbstractID.h.

                                 : DetectorID(rawid) {
    SUBDETECTORID_TEST("HcalAbstractID", SD_HCAL);
  }

HcalAbstractID() [3/4]

ldmx::HcalAbstractID::HcalAbstractID ( const DetectorID  id )

inline

Create from a DetectorID, but check.

Definition at line 50 of file HcalAbstractID.h.

                                      : DetectorID(id) {
    SUBDETECTORID_TEST("HcalAbstractID", SD_HCAL);
  }

HcalAbstractID() [4/4]

ldmx::HcalAbstractID::HcalAbstractID ( unsigned int  bar_type, unsigned int  payload  )

inline

Create from pieces.

Definition at line 57 of file HcalAbstractID.h.

      : DetectorID(SD_HCAL, 0) {
    id_ |= (bar_type & BAR_TYPE_MASK) << BAR_TYPE_SHIFT;
    id_ |= (payload & HCAL_PAYLOAD_MASK);
  }

References bar_type(), ldmx::DetectorID::id_, and payload().

Member Function Documentation

bar_type()

int ldmx::HcalAbstractID::bar_type ( ) const

inline

Get the value of the bar field from the ID.

Returns

The value of the bar field.

Definition at line 67 of file HcalAbstractID.h.

{ return (id_ >> BAR_TYPE_SHIFT) & BAR_TYPE_MASK; }

References ldmx::DetectorID::id_.

Referenced by HcalAbstractID(), ldmx::HcalDigiID::HcalDigiID(), ldmx::HcalDigiID::HcalDigiID(), ldmx::HcalID::HcalID(), ldmx::HcalID::HcalID(), ldmx::HcalTriggerID::HcalTriggerID(), and ldmx::HcalTriggerID::HcalTriggerID().

payload()

int ldmx::HcalAbstractID::payload ( ) const

inline

Get the value of the payload field from the ID.

Returns

The value of the payload field.

Definition at line 73 of file HcalAbstractID.h.

{ return id_ & HCAL_PAYLOAD_MASK; }

References ldmx::DetectorID::id_.

Referenced by HcalAbstractID().

Member Data Documentation

BAR_TYPE_MASK

const RawValue ldmx::HcalAbstractID::BAR_TYPE_MASK {0x7}

static

Definition at line 31 of file HcalAbstractID.h.

{0x7};  // space for up to eight bar types

BAR_TYPE_SHIFT

const RawValue ldmx::HcalAbstractID::BAR_TYPE_SHIFT {23}

static

Definition at line 32 of file HcalAbstractID.h.

{23};

HCAL_PAYLOAD_MASK

const RawValue ldmx::HcalAbstractID::HCAL_PAYLOAD_MASK {0x007FFFFF}

static

Definition at line 33 of file HcalAbstractID.h.

{0x007FFFFF};

---

The documentation for this class was generated from the following file:

• DetDescr/include/DetDescr/HcalAbstractID.h