Mantid
Loading...
Searching...
No Matches
SaveNXcanSAS.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2016 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
18class MANTID_DATAHANDLING_DLL SaveNXcanSAS final : public API::Algorithm {
19public:
23 ~SaveNXcanSAS() override = default;
24 const std::string name() const override { return "SaveNXcanSAS"; }
26 const std::string summary() const override { return "Writes a MatrixWorkspace to a file in the NXcanSAS format."; }
27
29 int version() const override { return (1); }
30 const std::vector<std::string> seeAlso() const override { return {"SaveCanSAS1D", "LoadNXcanSAS"}; }
32 const std::string category() const override { return "DataHandling\\Nexus"; }
33
34 std::map<std::string, std::string> validateInputs() override;
35
36private:
38 void init() override;
40 void exec() override;
41};
42
43std::string MANTID_DATAHANDLING_DLL makeCanSASRelaxedName(const std::string &input);
44
45} // namespace DataHandling
46} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
SaveNXcanSAS : Saves a reduced workspace in the NXcanSAS format.
Definition: SaveNXcanSAS.h:18
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: SaveNXcanSAS.h:30
int version() const override
Algorithm's version.
Definition: SaveNXcanSAS.h:29
const std::string category() const override
Algorithm's category for identification.
Definition: SaveNXcanSAS.h:32
~SaveNXcanSAS() override=default
Virtual dtor.
const std::string summary() const override
Summary of algorithms purpose.
Definition: SaveNXcanSAS.h:26
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition: SaveNXcanSAS.h:24
std::string MANTID_DATAHANDLING_DLL makeCanSASRelaxedName(const std::string &input)
This makes out of an input a relaxed name, something conforming to "[A-Za-z_][\w_]*" For now "-" is c...
Helper class which provides the Collimation Length for SANS instruments.