Mantid
Loading...
Searching...
No Matches
SetCrystalLocation.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/*
8 * SetCrystalLocation.h
9 *
10 * Created on: Dec 12, 2018
11 * Author: Brendan Sullivan
12 */
13
14#pragma once
15
16#include "MantidAPI/Algorithm.h"
17#include "MantidCrystal/DllConfig.h"
18
19namespace Mantid {
20namespace Crystal {
21
30class MANTID_CRYSTAL_DLL SetCrystalLocation final : public API::Algorithm {
31public:
32 const std::string name() const override { return "SetCrystalLocation"; };
34 const std::string summary() const override {
35 return "This algorithm sets the sample location of the "
36 "input event workspace.";
37 }
38 const std::vector<std::string> seeAlso() const override { return {"OptimizeCrystalPlacement"}; }
39
40 int version() const override { return 1; };
41
42 const std::string category() const override { return "Crystal\\Corrections"; };
43
44private:
45 void init() override;
46
47 void exec() override;
48};
49} // namespace Crystal
50} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
const std::string summary() const override
Summary of algorithms purpose.
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string category() const override
function to return a category of the algorithm.
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
Helper class which provides the Collimation Length for SANS instruments.