-
Notifications
You must be signed in to change notification settings - Fork 121
/
GeneratePythonScript.h
70 lines (54 loc) · 2.28 KB
/
GeneratePythonScript.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
66
67
68
69
70
#ifndef MANTID_ALGORITHMS_GENERATEPYTHONSCRIPT_H_
#define MANTID_ALGORITHMS_GENERATEPYTHONSCRIPT_H_
#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** GeneratePythonScript : TODO: DESCRIPTION
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>
@author Peter G Parker, ISIS, RAL
@date 2011-09-13
Copyright © 2011 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport GeneratePythonScript : public API::Algorithm {
public:
/// Algorithm's name for identification
const std::string name() const override { return "GeneratePythonScript"; };
/// 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; };
/// Algorithm's category for identification
const std::string category() const override { return "Utility\\Python"; }
protected:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_GENERATEPYTHONSCRIPT_H_ */