Mantid
Loading...
Searching...
No Matches
MaskBinsIf.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
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
14
17class MANTID_ALGORITHMS_DLL MaskBinsIf final : public API::Algorithm {
18public:
19 const std::string name() const override { return "MaskBinsIf"; }
20 int version() const override { return 1; }
21 const std::string category() const override { return "Transforms\\Masking"; }
22 std::map<std::string, std::string> validateInputs() override;
23 const std::string summary() const override { return "Masks bins based on muparser expression"; }
24 const std::vector<std::string> seeAlso() const override { return {"MaskBins"}; }
25
26private:
27 void init() override;
28 void exec() override;
29};
30
31} // namespace Algorithms
32} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
MaskBinsIf : Masks bins based on muparser expression.
Definition: MaskBinsIf.h:17
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: MaskBinsIf.h:24
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition: MaskBinsIf.h:19
const std::string category() const override
function to return a category of the algorithm.
Definition: MaskBinsIf.h:21
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
Definition: MaskBinsIf.h:23
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
Definition: MaskBinsIf.h:20
Helper class which provides the Collimation Length for SANS instruments.