-
Notifications
You must be signed in to change notification settings - Fork 121
/
SavePHX.h
82 lines (75 loc) · 2.65 KB
/
SavePHX.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
71
72
73
74
75
76
77
78
79
80
81
82
#ifndef SAVEPHX_H_
#define SAVEPHX_H_
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace DataHandling {
/**
* Saves a workspace into an ASCII PHX file.
*
* Required properties:
* <UL>
* <LI> InputWorkspace - The workspace name to save. </LI>
* <LI> Filename - The filename for output </LI>
* </UL>
*
* @author Stuart Campbell, NScD, Oak Ridge National Laboratory
* @date 27/07/2010
*
* Copyright © 2009-2010 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 SavePHX : public Mantid::API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override { return "SavePHX"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Writes the detector geometry information of a workspace into a PHX "
"format file.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override {
return "DataHandling\\SPE;Inelastic\\DataHandling";
}
/** the method used in tests. It requested the ChildAlgorithm, which does the
detectors
* position calculations to produce a target workspace. This workspace then
can be retrieved
from analysis data service and used to check the results of the save
algorithm. */
void set_resulting_workspace(const std::string &ws_name) {
det_par_ws_name = ws_name;
}
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
/// The name of the table workpsace with detectors positions used in tests
std::string det_par_ws_name;
};
} // namespace DataHandling
} // namespace Mantid
#endif /*SAVEPHX_H_*/