-
Notifications
You must be signed in to change notification settings - Fork 122
/
CopySample.h
80 lines (65 loc) · 2.7 KB
/
CopySample.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
#ifndef MANTID_ALGORITHMS_COPYSAMPLE_H_
#define MANTID_ALGORITHMS_COPYSAMPLE_H_
#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/Sample.h"
namespace Mantid {
namespace Algorithms {
/** CopySample : The algorithm copies some/all the sample information from one
workspace to another.
For MD workspaces, if no input sample number is specified, or not found, it will
copy the first sample.
For MD workspaces, if no output sample number is specified (or negative), it
will copy to all samples. The following information can be copied:
Name
Material
Sample environment
Shape
Oriented lattice
@author Andrei Savici, ORNL
@date 2011-08-11
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 CopySample : public API::Algorithm {
public:
/// Algorithm's name for identification
const std::string name() const override { return "CopySample"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Copy some/all the sample information from one workspace to "
"another.";
}
/// Algorithm's version for identification
int version() const override { return 1; };
/// Algorithm's category for identification
const std::string category() const override {
return "Sample;Utility\\Workspaces";
}
std::map<std::string, std::string> validateInputs() override;
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
/// Function to copy information from one sample to another
void copyParameters(API::Sample &from, API::Sample &to, bool nameFlag,
bool materialFlag, bool environmentFlag, bool shapeFlag,
bool latticeFlag, bool orientationOnlyFlag);
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_COPYSAMPLE_H_ */