Mantid
Loading...
Searching...
No Matches
MultiplyRange.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidAlgorithms/DllConfig.h"
14
15namespace Mantid {
16namespace Algorithms {
32class MANTID_ALGORITHMS_DLL MultiplyRange final : public API::Algorithm {
33public:
34 const std::string name() const override { return "MultiplyRange"; }
36 const std::string summary() const override {
37 return "An algorithm to multiply a range of bins in a workspace by the "
38 "factor given.";
39 }
40
41 int version() const override { return (1); }
42 const std::vector<std::string> seeAlso() const override { return {"Multiply"}; }
43 const std::string category() const override { return "Arithmetic;CorrectionFunctions"; }
44
45private:
47 void init() override;
49 void exec() override;
50};
51
52} // namespace Algorithms
53} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
An algorithm to multiply a range of bins in a workspace by the factor given.
Definition: MultiplyRange.h:32
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: MultiplyRange.h:42
const std::string summary() const override
Summary of algorithms purpose.
Definition: MultiplyRange.h:36
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition: MultiplyRange.h:34
const std::string category() const override
function to return a category of the algorithm.
Definition: MultiplyRange.h:43
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
Definition: MultiplyRange.h:41
Helper class which provides the Collimation Length for SANS instruments.