FullSecID.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 <vxd/dataobjects/VxdID.h>
#include <string>
#include <ostream>
 
 
 
namespace Belle2 {
  class FullSecID {
  public:
 
 
    typedef unsigned int BaseType;
 
 
    // starting with operator overloading...
    bool operator<(const FullSecID& secID)  const { return m_fullSecID < secID.m_fullSecID; }
 
 
    bool operator==(const FullSecID& secID) const { return m_fullSecID == secID.m_fullSecID; }
 
    bool equalIgnoreSubLayerID(const FullSecID& secID)
    {
      return ((~FullSecID::SubLayerMask)&m_fullSecID) == ((~FullSecID::SubLayerMask)&secID.m_fullSecID);
    }
 
    FullSecID& operator=(const FullSecID& secID) { m_fullSecID = secID.m_fullSecID; return *this; }
 
 
    operator unsigned int() const { return m_fullSecID; }
 
 
    operator std::string(void) const { return getFullSecString(); }
 
 
    friend std::ostream& operator<< (std::ostream& out, const FullSecID& secID) { out << secID.getFullSecString(); return out; }
 
 
    // constructors...
    FullSecID(const FullSecID& secID): m_fullSecID(secID.m_fullSecID) {}
 
 
    explicit FullSecID(unsigned int id = 0):
      m_fullSecID(id) {}
 
 
    explicit FullSecID(std::string sid);
 
 
    explicit FullSecID(VxdID vxdID, bool subLayerID = false, unsigned int sectorNumber = 0);
 
 
    FullSecID(unsigned int layerID, bool subLayerID, unsigned int sensorID, unsigned int sectorNumber);
 
 
    ~FullSecID() {}
 
 
    short int getLayerID() const { return getLayerNumber(); }
 
 
    short int getLayerNumber() const { return m_fullSecID >> LayerBitShift; }
 
 
    int getLadderID() const { return getLadderNumber(); }
 
 
    int getLadderNumber() const { return getVxdID().getLadderNumber(); }
 
 
    bool getSubLayerID() const { return (m_fullSecID bitand SubLayerMask) >> SubLayerBitShift; }
 
 
    VxdID getVxdID() const { return VxdID((m_fullSecID bitand VxdIDMask) >> VxdIDBitShift); }
 
 
    unsigned short int getUniID() const { return (m_fullSecID bitand VxdIDMask) >> VxdIDBitShift; }
 
 
    short int getSecID() const { return (m_fullSecID bitand SectorMask); }
 
 
    unsigned int getFullSecID() const { return m_fullSecID; }
 
 
    std::string getFullSecString() const;
 
  protected:
    const static int LayerBits;
 
 
    const static int SubLayerBits;
 
 
    const static int VxdIDBits;
 
 
    const static int SectorBits;
 
 
    const static int Bits;
 
 
    const static int MaxLayer;
 
 
    const static int MaxSubLayer;
 
 
    const static int MaxVxdID;
 
 
    const static int MaxSector;
 
 
    const static int MaxID;
 
 
    const static int LayerBitShift;
 
 
    const static int SubLayerBitShift;
 
 
    const static int VxdIDBitShift;
 
 
    const static int SubLayerMask;
 
 
    const static int VxdIDMask;
 
 
    const static int SectorMask;
 
    BaseType m_fullSecID;
 
  }; //end class SecID
} //end namespace Belle2