SimSpecialID.h

 
#ifndef DETDESCR_SIMSPECIALID_H
#define DETDESCR_SIMSPECIALID_H
 
// LDMX
#include "DetDescr/DetectorID.h"
 
namespace ldmx {
 
class SimSpecialID : public DetectorID {
 public:
  enum SimSpecialType { SCORING_PLANE = 1 };
 
  static const RawValue SUBTYPE_MASK{0xF};  // space for up to 15 subtypes
  static const RawValue SUBTYPE_SHIFT{22};
  static const RawValue SUBTYPE_DATA_MASK{0x3FFFFF};
 
  // scoring plane only
  static const RawValue PLANE_MASK{
      0xFFF};  // space for up to 4096 scoring planes
  static const RawValue PLANE_SHIFT{0};
 
  SimSpecialID() : DetectorID(SD_SIM_SPECIAL, 0) {}
 
  SimSpecialID(RawValue rawid) : DetectorID(rawid) {
    SUBDETECTORID_TEST("SimSpecialID", SD_SIM_SPECIAL);
  }
 
  SimSpecialID(const DetectorID id) : DetectorID(id) {
    SUBDETECTORID_TEST("SimSpecialID", SD_SIM_SPECIAL);
  }
 
  SimSpecialID(SimSpecialType sst, RawValue rawfield)
      : DetectorID(SD_SIM_SPECIAL, 0) {
    id_ |= ((sst & SUBTYPE_MASK) << SUBTYPE_SHIFT);
    id_ |= rawfield & SUBTYPE_DATA_MASK;
  }
 
  static SimSpecialID ScoringPlaneID(int plane) {
    return SimSpecialID(SCORING_PLANE, (plane & PLANE_MASK) << PLANE_SHIFT);
  }
 
  /*
   * Get the value of the 'section' field from the ID.
   * @return The value of the 'strip' field.
   */
  SimSpecialType getSubtype() const {
    return SimSpecialType((id_ >> SUBTYPE_SHIFT) & SUBTYPE_MASK);
  }
 
  int plane() const {
    return (getSubtype() == SCORING_PLANE) ? ((id_ >> PLANE_SHIFT) & PLANE_MASK)
                                           : (-1);
  }
 
  RawValue subtypePayload() const { return id_ & SUBTYPE_DATA_MASK; }
 
  static void createInterpreters();
};
}  // namespace ldmx
 
std::ostream& operator<<(std::ostream&, const ldmx::SimSpecialID&);
 
#endif