DeprecatedAlias.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2021 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 +
 
#include "MantidAPI/DeprecatedAlias.h"
#include "MantidAPI/AlgorithmFactory.h"
#include "MantidKernel/Logger.h"
#include "MantidTypes/Core/DateAndTimeHelpers.h"
 
namespace Mantid::API {
 
namespace {
Kernel::Logger g_log("DeprecatedAlias");
} // namespace
 
DeprecatedAlias::DeprecatedAlias() : m_deprecationDate() {}
 
DeprecatedAlias::~DeprecatedAlias() = default;
 
void DeprecatedAlias::setDeprecationDate(const std::string &date) {
  m_deprecationDate = "";
  if ((!date.empty()) && (Types::Core::DateAndTimeHelpers::stringIsISO8601(date))) {
    m_deprecationDate = date;
  } else {
    throw std::invalid_argument("DeprecatedAlias::DeprecationDate(): deprecation date must follow ISO8601.");
  }
}
 
std::string DeprecatedAlias::deprecationMessage(const IAlgorithm *algo) {
  std::stringstream msg;
 
  auto alias = algo->alias();
 
  if (alias.empty()) {
    throw std::logic_error("Cannot find the deprecated alias for this algorithm.");
  } else {
    msg << "The algorithm '" << alias << "' is deprecated on " << m_deprecationDate << "."
        << "Please use '" << algo->name() << "' instead.";
  }
 
  return msg.str();
}
 
} // namespace Mantid::API