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
9#include "MantidDataHandling/DllConfig.h"
11
12namespace Mantid {
13namespace DataHandling {
14
18class MANTID_DATAHANDLING_DLL SaveNXcanSAS final : public SaveNXcanSASBase {
19public:
23 ~SaveNXcanSAS() override = default;
24 const std::string name() const override { return "SaveNXcanSAS"; }
26 const std::string summary() const override {
27 return "Save a MatrixWorkspace to a file in the NXcanSAS format (for both 1D and 2D data).";
28 }
30 bool checkGroups() override;
31 bool processGroups() override;
32
34 int version() const override { return (1); }
35 const std::vector<std::string> seeAlso() const override { return {"SaveCanSAS1D", "LoadNXcanSAS"}; }
37 const std::string category() const override { return "DataHandling\\Nexus"; }
38
39 std::map<std::string, std::string> validateInputs() override;
40
41private:
43 void init() override;
45 void exec() override;
46 void processAllWorkspaces();
47
48 std::vector<API::MatrixWorkspace_sptr> m_workspaces;
49};
50
51} // namespace DataHandling
52} // namespace Mantid
SaveNXcanSASBase : Base class to save a reduced workspace in the NXcanSAS format.
SaveNXcanSAS : Saves a reduced workspace in the NXcanSAS format.
std::vector< API::MatrixWorkspace_sptr > m_workspaces
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
int version() const override
Algorithm's version.
const std::string category() const override
Algorithm's category for identification.
~SaveNXcanSAS() override=default
Virtual dtor.
const std::string summary() const override
Summary of algorithms purpose.
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Helper class which provides the Collimation Length for SANS instruments.