IntervalOfValidity.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 <iosfwd>
#include <Rtypes.h>
 
namespace Belle2 {
  class EventMetaData;

  class IntervalOfValidity final {
  public:
    IntervalOfValidity(): IntervalOfValidity(-1, -1, -1, -1) {}

    IntervalOfValidity(int experimentLow, int runLow, int experimentHigh, int runHigh);

    ~IntervalOfValidity() = default;

    bool contains(const int experiment, const int run) const;

    bool contains(const EventMetaData& event) const;

    bool empty() const {return ((m_experimentLow < 0) && (m_experimentHigh < 0));};

    static IntervalOfValidity always() {return IntervalOfValidity(0, 0, -1, -1);};

    bool operator==(const IntervalOfValidity& other) const
    {
      return (m_experimentLow == other.m_experimentLow) && (m_runLow == other.m_runLow) &&
             (m_experimentHigh == other.m_experimentHigh) && (m_runHigh == other.m_runHigh);
    }

    bool operator!=(const IntervalOfValidity& other) const
    {
      return !(*this == other);
    }

    bool contains(const IntervalOfValidity& iov) const {return overlap(iov) == iov;};

    bool overlaps(const IntervalOfValidity& iov) const {return !overlap(iov).empty();};

    IntervalOfValidity overlap(const IntervalOfValidity& iov) const;

    bool trimOverlap(IntervalOfValidity& iov, bool trimOlder = true);

    int getExperimentLow() const
    {
      return m_experimentLow;
    }

    int getRunLow() const
    {
      return m_runLow;
    }

    int getExperimentHigh() const
    {
      return m_experimentHigh;
    }

    int getRunHigh() const
    {
      return m_runHigh;
    }

    friend std::istream& operator>> (std::istream& input, IntervalOfValidity& iov);

    friend std::ostream& operator<< (std::ostream& output, const IntervalOfValidity& iov);
 
  private:

    int m_experimentLow;

    int m_runLow;

    int m_experimentHigh;

    int m_runHigh;

    int checkLowerBound(int experiment, int run) const;

    int checkUpperBound(int experiment, int run) const;

    void makeValid();
 
    ClassDefNV(IntervalOfValidity, 2);  
  };

}