RecordPythonScript.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidAPI/AlgorithmObserver.h"
#include "MantidAPI/DeprecatedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidAlgorithms/GeneratePythonScript.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL RecordPythonScript : public Algorithms::GeneratePythonScript,
                                                 public API::AlgorithmObserver,
                                                 public API::DeprecatedAlgorithm {
public:
  RecordPythonScript();
  const std::string name() const override { return "RecordPythonScript"; };
  const std::string summary() const override {
    return "An Algorithm to generate a Python script file to reproduce the "
           "history of a workspace.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"GenerateIPythonNotebook", "GeneratePythonScript"};
  }
  const std::string category() const override { return "Utility\\Python"; }
 
private:
  void init() override;
  void exec() override;
  const std::string alias() const override;
  void startingHandle(API::IAlgorithm_sptr alg) override;
  std::string m_generatedScript;
};
 
} // namespace Algorithms
} // namespace Mantid