KLMChannelIndex.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
 
/* KLM headers. */
#include <klm/dataobjects/KLMElementNumbers.h>
 
namespace Belle2 {
  class KLMChannelIndex {
 
  public:
 
    enum IndexLevel {
 
      c_IndexLevelSubdetector = 1,
 
      c_IndexLevelSection = 2,
 
      c_IndexLevelSector = 3,
 
      c_IndexLevelLayer = 4,
 
      c_IndexLevelPlane = 5,
 
      c_IndexLevelStrip = 6,
 
    };
 
    explicit KLMChannelIndex(enum IndexLevel indexLevel = c_IndexLevelStrip);
 
    KLMChannelIndex(int subdetector, int section, int sector,
                    int layer, int plane, int strip,
                    enum IndexLevel indexLevel = c_IndexLevelStrip);
 
    ~KLMChannelIndex();
 
    void setIndexLevel(enum IndexLevel indexLevel);
 
    void useEKLMSegments(bool useSegments = true);
 
    void setKLMModule(KLMModuleNumber module);
 
    void setEKLMSegment(int segment);
 
    int getSubdetector() const
    {
      return m_Subdetector;
    }
 
    int getSection() const
    {
      return m_Section;
    }
 
    int getSector() const
    {
      return m_Sector;
    }
 
    int getLayer() const
    {
      return m_Layer;
    }
 
    int getPlane() const
    {
      return m_Plane;
    }
 
    int getStrip() const
    {
      return m_Strip;
    }
 
    KLMChannelNumber getKLMChannelNumber() const;
 
    KLMPlaneNumber getKLMPlaneNumber() const;
 
    KLMModuleNumber getKLMModuleNumber() const;
 
    KLMSectorNumber getKLMSectorNumber() const;
 
    int getEKLMSegmentNumber() const;
 
    KLMChannelIndex beginBKLM();
 
    KLMChannelIndex& endBKLM();
 
    KLMChannelIndex beginEKLM();
 
    KLMChannelIndex& endEKLM();
 
    KLMChannelIndex begin()
    {
      return beginBKLM();
    }
 
    KLMChannelIndex& end()
    {
      return endEKLM();
    }
 
    KLMChannelIndex& operator++();
 
    KLMChannelIndex& increment();
 
    bool operator==(const KLMChannelIndex& index) const;
 
    bool operator!=(const KLMChannelIndex& index) const;
 
    KLMChannelIndex& operator*();
 
  protected:
 
    void setNStripsPlane();
 
    void increment(enum IndexLevel indexLevel);
 
    enum IndexLevel m_IndexLevel;
 
    int m_Subdetector;
 
    int m_Section;
 
    int m_Sector;
 
    int m_Layer;
 
    int m_Plane;
 
    int m_Strip;
 
    bool m_UseEKLMSegments = false;
 
    int m_NStripsPlane;
 
    const KLMElementNumbers* m_ElementNumbers;
 
    const EKLMElementNumbers* m_eklmElementNumbers;
 
  };
 
}