ProgressBase.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidKernel/DllConfig.h"
 
#include <atomic>
#include <memory>
#include <string>
 
namespace Mantid {
namespace Kernel {
//---------------------------------------------------------------------------
// Forward Declarations
//---------------------------------------------------------------------------
class Timer;
 
class MANTID_KERNEL_DLL ProgressBase {
public:
  ProgressBase();
  ProgressBase(double start, double end, int64_t numSteps);
  ProgressBase(const ProgressBase &source);
  ProgressBase &operator=(const ProgressBase &rhs);
  virtual ~ProgressBase();
 
  virtual void doReport(const std::string &msg = "") = 0;
  virtual bool hasCancellationBeenRequested() const { return false; }
 
  // ----------------------- Methods shared between progress reporters
  // -----------------------
 
  //----------------------------------------------------------------------------------------------
  void report() {
    // This function was put inline for highest speed.
    if (++m_i - m_last_reported < m_notifyStep)
      return;
    m_last_reported.store(m_i.load());
    this->doReport("");
  }
 
  void report(const std::string &msg);
  void report(int64_t i, const std::string &msg = "");
  void reportIncrement(int inc, const std::string &msg = "");
  void reportIncrement(size_t inc, const std::string &msg = "");
  void setNumSteps(int64_t nsteps);
  void resetNumSteps(int64_t nsteps, double start, double end);
  void setNotifyStep(double notifyStepPct);
 
  double getEstimatedTime() const;
 
protected:
  double m_start;
  double m_end;
  int64_t m_ifirst;
  int64_t m_numSteps;
  int64_t m_notifyStep;
  double m_notifyStepPct;
  double m_step;
  std::atomic<int64_t> m_i;
  std::atomic<int64_t> m_last_reported;
  std::unique_ptr<Kernel::Timer> m_timeElapsed;
  int m_notifyStepPrecision;
};
 
} // namespace Kernel
} // namespace Mantid