VxdID.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <string>
#include <ostream>
 
namespace Belle2 {
  class VxdID {
  public:
    typedef unsigned short baseType;
    enum {
      LayerBits   = 3,
      LadderBits  = 5,
      SensorBits  = 3,
      SegmentBits = 5,
      Bits        = LayerBits + LadderBits + SensorBits + SegmentBits,

      MaxLayer    = (1 << LayerBits) - 1,
      MaxLadder   = (1 << LadderBits) - 1,
      MaxSensor   = (1 << SensorBits) - 1,
      MaxSegment  = (1 << SegmentBits) - 1,
      MaxID       = (1 << Bits) - 1
    };

    // cppcheck-suppress noExplicitConstructor
    VxdID(baseType id = 0)
    {
      m_id.id = id;
    }

    VxdID(baseType layer, baseType ladder, baseType sensor, baseType segment = 0)
    {
      m_id.parts.layer   = layer;
      m_id.parts.ladder  = ladder;
      m_id.parts.sensor  = sensor;
      m_id.parts.segment = segment;
    }

    explicit VxdID(const std::string& sensor);
    VxdID(const VxdID& b): m_id(b.m_id) {}

    VxdID& operator=(const VxdID& b)        { m_id = b.m_id; return *this; }
    VxdID& operator=(baseType id)     { m_id.id = id; return *this; }
    operator baseType() const         { return getID(); }
    operator std::string() const;
    bool operator==(const VxdID& b) const   { return getID() == b.getID(); }
    bool operator<(const VxdID& b) const    { return getID() < b.getID(); }

    baseType getID() const            { return m_id.id; }
    baseType getLayerNumber() const         { return m_id.parts.layer; }
    baseType getLadderNumber() const        { return m_id.parts.ladder; }
    baseType getSensorNumber() const        { return m_id.parts.sensor; }
    baseType getSegmentNumber() const       { return m_id.parts.segment; }

    void setID(baseType id)           { m_id.id = id; }
    void setLayerNumber(baseType layer)     { m_id.parts.layer  = layer;  }
    void setLadderNumber(baseType ladder)   { m_id.parts.ladder = ladder; }
    void setSensorNumber(baseType sensor)   { m_id.parts.sensor = sensor; }
    void setSegmentNumber(baseType segment) { m_id.parts.segment = segment; }

    std::string __str__() const { return (std::string)(*this); }
 
  private:
 
    union {
      // *INDENT-OFF*
      baseType id: Bits;
      struct {
        baseType segment: SegmentBits;
        baseType sensor: SensorBits;
        baseType ladder: LadderBits;
        baseType layer: LayerBits;
      } parts ;
      // *INDENT-ON*
    } m_id; 
  };

  std::ostream& operator<<(std::ostream& out, const VxdID& id);
}