DetectorID.h

 
#ifndef DETDESCR_DETECTORID_H_
#define DETDESCR_DETECTORID_H_
 
#include <cstdint>
#include <iostream>
 
#include "Framework/Exception/Exception.h"
 
namespace ldmx {
 
typedef enum SubdetectorIDTypeEnum {
  SD_NULL = 0,
  SD_TRACKER_TAGGER = 1,
  SD_TRIGGER_SCINT = 2,
  SD_ACTVE_TARGET = 3,
  SD_TRACKER_RECOIL = 4,
  SD_ECAL = 5,
  SD_HCAL = 6,
  SD_SIM_SPECIAL = 7,
  SD_TRACKER_TESTSTAND = 8,
  EID_TRACKER = 16,
  EID_TRIGGER_SCINT = 17,
  EID_ECAL = 18,
  EID_HCAL = 19
} SubdetectorIDType;
 
class DetectorID {
 public:
  typedef uint32_t RawValue;
 
  static const RawValue SUBDETECTORID_MASK{0x3F};
  static const RawValue SUBDETECTORID_SHIFT{26};
  static const RawValue SUBDETECTOR_PAYLOAD_MASK{0x3FFFFFF};
 
  DetectorID() : id_{0} {}
 
  DetectorID(RawValue rawid) : id_{rawid} {}
 
  DetectorID(SubdetectorIDType sdtype, RawValue raw_subpayload) {
    id_ = ((RawValue(sdtype) & DetectorID::SUBDETECTORID_MASK)
           << DetectorID::SUBDETECTORID_SHIFT) |
          (raw_subpayload & DetectorID::SUBDETECTOR_PAYLOAD_MASK);
  }
 
  bool null() const { return id_ == 0; }
 
  SubdetectorIDType subdet() const {
    return SubdetectorIDType((id_ >> SUBDETECTORID_SHIFT) & SUBDETECTORID_MASK);
  }
 
  RawValue raw() const { return id_; }
 
  void setRawValue(RawValue rawValue) { id_ = rawValue; }
 
  bool operator<(const DetectorID& id) const { return id_ < id.id_; }
 
  bool operator==(const DetectorID& id) const { return id_ == id.id_; }
 
  bool operator!=(const DetectorID& id) const { return id_ != id.id_; }
 
 protected:
  RawValue id_;
};
 
}  // namespace ldmx
 
#define SUBDETECTORID_TEST(a, x)                                           \
  if (!null() && !(subdet() == x)) {                                       \
    EXCEPTION_RAISE("DetectorIDMismatch", "Attempted to create " +         \
                                              std::string(a) +             \
                                              " from mismatched source " + \
                                              std::to_string(subdet()));   \
  }
#define SUBDETECTORID_TEST2(a, x, y)                                       \
  if (!null() && !(subdet() == x || subdet() == y)) {                      \
    EXCEPTION_RAISE("DetectorIDMismatch", "Attempted to create " +         \
                                              std::string(a) +             \
                                              " from mismatched source " + \
                                              std::to_string(subdet()));   \
  }
#define SUBDETECTORID_TEST3(a, x, y, z)                                    \
  if (!null() && !(subdet() == x || subdet() == y || subdet() == z)) {     \
    EXCEPTION_RAISE("DetectorIDMismatch", "Attempted to create " +         \
                                              std::string(a) +             \
                                              " from mismatched source " + \
                                              std::to_string(subdet()));   \
  }
 
std::ostream& operator<<(std::ostream&, const ldmx::DetectorID&);
 
#endif