-
Notifications
You must be signed in to change notification settings - Fork 122
/
LoadSampleEnvironment.h
61 lines (55 loc) · 2.08 KB
/
LoadSampleEnvironment.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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source
// & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
#ifndef DATAHANDLING_LOAD_ENVIRONMENT_H_
#define DATAHANDLING_LOAD_ENVIRONMENT_H_
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Geometry {
class MeshObject;
}
namespace DataHandling {
/**
* Load Environment into the sample of a workspace, either replacing the
* current environment, or replacing it, you may also set the material
*
* The following file types are supported:
* - STL file with suffix .stl
*/
class DLLExport LoadSampleEnvironment : public Mantid::API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "LoadSampleEnvironment"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "The algorithm loads an Environment into the instrument of a "
"workspace "
"at the sample.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
/// Related algorithms
const std::vector<std::string> seeAlso() const override {
return {"CreateSampleEnvironment", "CopySample", "SetSampleMaterial",
"LoadSampleShape"};
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override {
return "DataHandling\\Instrument";
}
boost::shared_ptr<Geometry::MeshObject>
translate(boost::shared_ptr<Geometry::MeshObject> environmentMesh);
boost::shared_ptr<Geometry::MeshObject>
rotate(boost::shared_ptr<Geometry::MeshObject> environmentMesh);
std::map<std::string, std::string> validateInputs() override;
private:
// Implement abstract Algorithm methods
void init() override;
void exec() override;
};
} // end namespace DataHandling
} // namespace Mantid
#endif /* DATAHANDLING_LOAD_ENVIRONMENT_H_ */