Progress.cpp

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 +
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Progress.h"
#include "MantidAPI/Algorithm.h"
 
namespace Mantid::API {
 
namespace {
void checkEnd(double end) {
  if (end > 1.) {
    std::stringstream msg;
    msg << "Progress range invalid. end=" << end;
    throw std::invalid_argument(msg.str());
  }
}
} // namespace
 
Progress::Progress() : ProgressBase(0.0, 1.0, 0), m_alg(nullptr) {}
 
Progress::Progress(Algorithm *alg, double start, double end, int numSteps)
    : ProgressBase(start, end, int64_t(numSteps)), m_alg(alg) {
  checkEnd(end);
}
 
Progress::Progress(Algorithm *alg, double start, double end, int64_t numSteps)
    : ProgressBase(start, end, int64_t(numSteps)), m_alg(alg) {
  checkEnd(end);
}
 
Progress::Progress(Algorithm *alg, double start, double end, size_t numSteps)
    : ProgressBase(start, end, int64_t(numSteps)), m_alg(alg) {
  checkEnd(end);
}
 
void Progress::doReport(const std::string &msg) {
  // Progress as a float
  // must be between 0 and 1
  double p = m_start + m_step * double(m_i - m_ifirst);
  if (p > m_end)
    p = m_end;
  if (!m_alg)
    return;
  m_alg->progress(p, msg, this->getEstimatedTime(), this->m_notifyStepPrecision);
  m_alg->interruption_point();
}
 
bool Progress::hasCancellationBeenRequested() const {
  if (m_alg)
    return m_alg->getCancel();
  else
    return false;
}
 
} // namespace Mantid::API