-
Notifications
You must be signed in to change notification settings - Fork 122
/
RecordPythonScript.h
65 lines (57 loc) · 2.22 KB
/
RecordPythonScript.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// 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 {
/** RecordPythonScript :
An Algorithm to generate a Python script file to reproduce the history of a
workspace.
Properties:
<ul>
<li>Filename - the name of the file to write to. </li>
<li>InputWorkspace - the workspace name who's history is to be saved.</li>
</ul>
*/
class MANTID_ALGORITHMS_DLL RecordPythonScript : public Algorithms::GeneratePythonScript,
public API::AlgorithmObserver,
public API::DeprecatedAlgorithm {
public:
RecordPythonScript();
/// Algorithm's name for identification
const std::string name() const override { return "RecordPythonScript"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "An Algorithm to generate a Python script file to reproduce the "
"history of a workspace.";
}
/// Algorithm's version for identification
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return {"GenerateIPythonNotebook", "GeneratePythonScript"};
}
/// Algorithm's category for identification
const std::string category() const override { return "Utility\\Python"; }
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
const std::string alias() const override;
/** Handler of the start notifications. Must be overriden in inherited
classes.
@param alg :: Shared Pointer to the algorithm sending the notification.
*/
void startingHandle(API::IAlgorithm_sptr alg) override;
/// buffer for the script
std::string m_generatedScript;
};
} // namespace Algorithms
} // namespace Mantid