-
Notifications
You must be signed in to change notification settings - Fork 122
/
SavePHX.h
68 lines (62 loc) · 2.01 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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/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
*
*
*
*/
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); }
const std::vector<std::string> seeAlso() const override {
return {"SaveSPE"};
}
/// 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