Mantid
Loading...
Searching...
No Matches
RotateSource.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2015 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
10#include "MantidDataHandling/DllConfig.h"
11namespace Mantid {
12namespace DataHandling {
13
19class MANTID_DATAHANDLING_DLL RotateSource final : public API::Algorithm {
20public:
21 const std::string name() const override { return "RotateSource"; };
22 int version() const override { return 1; };
23 const std::vector<std::string> seeAlso() const override { return {"RotateInstrumentComponent"}; }
24 const std::string category() const override { return "DataHandling\\Instrument"; };
25 const std::string summary() const override { return "Rotates the source by a given angle"; };
26
27private:
28 void init() override;
29 void exec() override;
30};
31
32} // namespace DataHandling
33} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
RotateSource : Moves the source by a given angle taking into account the handedness.
Definition: RotateSource.h:19
const std::string category() const override
function to return a category of the algorithm.
Definition: RotateSource.h:24
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition: RotateSource.h:21
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
Definition: RotateSource.h:22
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
Definition: RotateSource.h:25
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: RotateSource.h:23
Helper class which provides the Collimation Length for SANS instruments.