Mantid
Loading...
Searching...
No Matches
LoadSampleShape.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
13
14namespace Mantid {
15namespace DataHandling {
28class MANTID_DATAHANDLING_DLL LoadSampleShape : public Mantid::API::Algorithm {
29public:
31 const std::string name() const override { return "LoadSampleShape"; };
33 const std::string summary() const override {
34 return "The algorithm loads a shape into the instrument of a workspace "
35 "at the sample.";
36 }
37
39 int version() const override { return 1; };
41 const std::vector<std::string> seeAlso() const override {
42 return {"CreateSampleShape", "CopySample", "SetSampleMaterial", "LoadSampleEnvironment"};
43 }
45 const std::string category() const override { return "DataHandling\\Instrument"; }
46
47private:
48 // Implement abstract Algorithm methods
49 void init() override;
50 void exec() override;
51};
52
53} // namespace DataHandling
54} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Load Shape into an instrument of a workspace.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Related algorithms.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
Helper class which provides the Collimation Length for SANS instruments.