DataProcessorAdapter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 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
 
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/DataProcessorAlgorithm.h"
#include "MantidPythonInterface/api/PythonAlgorithm/AlgorithmAdapter.h"
#include "MantidPythonInterface/core/Converters/PySequenceToVector.h"
#include "MantidPythonInterface/core/IsNone.h"
 
namespace Mantid {
namespace PythonInterface {
template <class Base> class DataProcessorAdapter : public AlgorithmAdapter<API::GenericDataProcessorAlgorithm<Base>> {
public:
  DataProcessorAdapter(PyObject *self);
 
  DataProcessorAdapter() = delete;
 
  DataProcessorAdapter(const DataProcessorAdapter &) = delete;
 
  DataProcessorAdapter &operator=(const DataProcessorAdapter &) = delete;
 
  // -------------------- Pass through methods ----------------------------
  // Boost.python needs public access to the base class methods in order to
  // be able to call them. We should just be able to put a using declaration
  // to raise the methods to public but this does not work on MSVC as in
  // the class_ definition it can't seem to figure out that its calling
  // this class not DataProcessorAlgorithm. This means we have to resort to
  // proxy methods :(
 
  void setLoadAlgProxy(const std::string &alg) { this->setLoadAlg(alg); }
 
  void setLoadAlgFilePropProxy(const std::string &filePropName) { this->setLoadAlgFileProp(filePropName); }
 
  void setAccumAlgProxy(const std::string &alg) { this->setAccumAlg(alg); }
 
  API::ITableWorkspace_sptr determineChunkProxy(const std::string &filename) { return this->determineChunk(filename); }
 
  void loadChunkProxy(const size_t rowIndex) { this->loadChunk(rowIndex); }
 
  void copyPropertiesProxy(const std::string &algName, const boost::python::object &propNames, const int version = -1) {
    if (algName.empty()) {
      throw std::invalid_argument("Failed to specify algorithm name");
    }
 
    std::vector<std::string> names;
    if (!Mantid::PythonInterface::isNone(propNames)) {
      boost::python::extract<std::string> extractor(propNames);
      if (extractor.check()) {
        names = std::vector<std::string>(1, extractor());
      } else {
        names = PythonInterface::Converters::PySequenceToVector<std::string>(propNames)();
      }
 
      auto algorithm = API::AlgorithmManager::Instance().createUnmanaged(algName, version);
      algorithm->initialize();
 
      for (const auto &name : names) {
        this->copyProperty(algorithm, name);
      }
    } else {
      std::string msg("Failed to specify properties to copy from \"");
      msg.append(algName).append("\"");
      throw std::invalid_argument(msg);
    }
  }
 
  API::Workspace_sptr loadProxy(const std::string &inputData, const bool loadQuiet = false) {
    return this->load(inputData, loadQuiet);
  }
 
  std::vector<std::string> splitInputProxy(const std::string &input) { return this->splitInput(input); }
 
  void forwardPropertiesProxy() { this->forwardProperties(); }
 
  std::shared_ptr<Kernel::PropertyManager>
  getProcessPropertiesProxy(const std::string &propertyManager = std::string()) {
    return this->getProcessProperties(propertyManager);
  }
 
  API::Workspace_sptr assembleProxy(const std::string &partialWSName, const std::string &outputWSName) {
    return this->assemble(partialWSName, outputWSName);
  }
 
  void saveNexusProxy(const std::string &outputWSName, const std::string &outputFile) {
    this->saveNexus(outputWSName, outputFile);
  }
 
  bool isMainThreadProxy() { return this->isMainThread(); }
 
  int getNThreadsProxy() { return this->getNThreads(); }
  // ------------------------------------------------------------------------
};
} // namespace PythonInterface
} // namespace Mantid