-
Notifications
You must be signed in to change notification settings - Fork 122
/
CreateSingleValuedWorkspace.h
72 lines (59 loc) · 2.2 KB
/
CreateSingleValuedWorkspace.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
#ifndef ALGORITHMSCREATESINGLEVALUEDWORKSPACE_H_
#define ALGORITHMSCREATESINGLEVALUEDWORKSPACE_H_
//------------------------------
// Includes
//------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/**
Required properties:
<UL>
<LI>OutputWorkspace - The name of workspace to create</LI>
<LI>DataValue - The value to place in this workspace</LI>
</UL>
Optional properties:
<UL>
<LI>ErrorValue - An error value</LI>
</UL>
@author Martyn Gigg, Tessella Support Services plc
@date 28/01/2009
Copyright © 2009 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 CreateSingleValuedWorkspace : public Mantid::API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override {
return "CreateSingleValuedWorkspace";
}
/// Summary of algorithms purpose
const std::string summary() const override {
return "Creates a 2D workspace containing a single X, Y & E value.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override { return "Utility\\Workspaces"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
}
}
#endif /*ALGORITHMSCREATESINGLEVALUEDWORKSPACE_H_*/