Mantid
Loading...
Searching...
No Matches
SaveMask.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 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"
11
12namespace Mantid {
13namespace DataHandling {
14
19class MANTID_DATAHANDLING_DLL SaveMask final : public API::Algorithm {
20public:
22 const std::string name() const override { return "SaveMask"; };
24 const std::string summary() const override { return "Save a MaskWorkspace/SpecialWorkspace2D to an XML file."; }
25
27 int version() const override { return 1; };
28 const std::vector<std::string> seeAlso() const override { return {"SaveMask", "LoadMask"}; }
30 const std::string category() const override { return "DataHandling\\Masking;Transforms\\Masking"; }
31
32private:
34 void init() override;
35
37 void exec() override;
38};
39
40} // namespace DataHandling
41} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
SaveMaskingToFile : TODO: DESCRIPTION.
Definition: SaveMask.h:19
const std::string name() const override
Algorithm's name for identification.
Definition: SaveMask.h:22
const std::string category() const override
Algorithm's category for identification.
Definition: SaveMask.h:30
const std::string summary() const override
Summary of algorithms purpose.
Definition: SaveMask.h:24
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: SaveMask.h:28
int version() const override
Algorithm's version for identification.
Definition: SaveMask.h:27
Helper class which provides the Collimation Length for SANS instruments.