Mantid
Loading...
Searching...
No Matches
GeneratePythonScript.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
14
29class MANTID_ALGORITHMS_DLL GeneratePythonScript : public API::SerialAlgorithm {
30public:
32 const std::string name() const override { return "GeneratePythonScript"; };
34 const std::string summary() const override {
35 return "An Algorithm to generate a Python script file to reproduce the "
36 "history of a workspace.";
37 }
38
40 int version() const override { return 1; };
41 const std::vector<std::string> seeAlso() const override { return {"RecordPythonScript", "GenerateIPythonNotebook"}; }
43 const std::string category() const override { return "Utility\\Python"; }
44
45protected:
47 const std::string alias() const override;
49 void init() override;
51 void exec() override;
52};
53
54} // namespace Algorithms
55} // namespace Mantid
Base class for algorithms that can only run serially (Parallel::ExecutionMode::MasterOnly) in an MPI ...
GeneratePythonScript : TODO: DESCRIPTION.
const std::string summary() const override
Summary of algorithms purpose.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string category() const override
Algorithm's category for identification.
const std::string name() const override
Algorithm's name for identification.
int version() const override
Algorithm's version for identification.
Helper class which provides the Collimation Length for SANS instruments.