DeprecatedAlgorithmChecker.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 +
#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/DeprecatedAlgorithm.h"
#include "MantidAPI/DeprecatedAlias.h"
#include <boost/python/class.hpp>
 
using Mantid::API::AlgorithmManager;
using Mantid::API::DeprecatedAlgorithm;
using Mantid::API::DeprecatedAlias;
using Mantid::API::IAlgorithm_sptr;
 
using namespace boost::python;
 
namespace {
class DeprecatedAlgorithmChecker {
public:
  DeprecatedAlgorithmChecker(const std::string &algName, int version)
      : m_alg(AlgorithmManager::Instance().createUnmanaged(algName, version)) {}
 
  const std::string isDeprecated() const {
    std::string deprecMessage;
    auto *depr = dynamic_cast<DeprecatedAlgorithm *>(m_alg.get());
    auto *deprecatedAliasAlg = dynamic_cast<DeprecatedAlias *>(m_alg.get());
 
    if (depr)
      deprecMessage = depr->deprecationMsg(m_alg.get());
    else if (deprecatedAliasAlg)
      deprecMessage = deprecatedAliasAlg->deprecationMessage(m_alg.get());
 
    return deprecMessage;
  }
 
private:
  DeprecatedAlgorithmChecker() = delete;
  IAlgorithm_sptr m_alg;
};
} // namespace
 
void export_DeprecatedAlgorithmChecker() {
  class_<DeprecatedAlgorithmChecker>("DeprecatedAlgorithmChecker", no_init)
      .def(init<const std::string &, int>((arg("algName"), arg("version")),
                                          "Constructs a DeprecatedAlgorithmChecker for the given algorithm & "
                                          "version. (-1 indicates latest version)"))
      .def("isDeprecated", &DeprecatedAlgorithmChecker::isDeprecated,
           "A string containing a deprecation message if the algorithm is "
           "deprecated, empty string otherwise");
}