Mantid
Loading...
Searching...
No Matches
SetInstrumentParameter.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2014 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 "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13
14namespace Geometry {
15class ParameterMap;
16class IComponent;
17} // namespace Geometry
18
19namespace Algorithms {
20
24class MANTID_ALGORITHMS_DLL SetInstrumentParameter final : public API::Algorithm {
25public:
26 const std::string name() const override;
28 const std::string summary() const override {
29 return "Add or replace an parameter attached to an instrument component.";
30 }
31
32 int version() const override;
33 const std::vector<std::string> seeAlso() const override {
34 return {"RotateInstrumentComponent", "MoveInstrumentComponent"};
35 }
36 const std::string category() const override;
37 std::map<std::string, std::string> validateInputs() override;
38
39private:
40 void init() override;
41 void exec() override;
42
44 const std::string &paramName, const std::string &paramType, const std::string &paramValue) const;
45};
46
47} // namespace Algorithms
48} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
SetInstrumentParameter : A simple algorithm to add or set the value of an instrument parameter.
const std::string summary() const override
Summary of algorithms purpose.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
base class for Geometric IComponent
Definition: IComponent.h:51
Helper class which provides the Collimation Length for SANS instruments.
Generate a tableworkspace to store the calibration results.