SaveNexus.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/SerialAlgorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include <climits>
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveNexus : public API::SerialAlgorithm {
public:
  const std::string name() const override { return "SaveNexus"; };
  const std::string summary() const override {
    return "The SaveNexus algorithm will write the given Mantid workspace to a "
           "NeXus file. SaveNexus currently just invokes SaveNexusProcessed.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"SaveISISNexus", "SaveNexusPD", "SaveNexusProcessed", "LoadNexus"};
  }
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
private:
  void init() override;
 
  void exec() override;
 
  std::string m_filename;
  std::string m_entryname;
  std::string m_dataname;
  std::string m_filetype;
  API::Workspace_sptr m_inputWorkspace;
  void runSaveNexusProcessed();
  void setOtherProperties(IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue,
                          int perioidNum) override;
 
protected:
  bool processGroups() override;
};
 
} // namespace DataHandling
} // namespace Mantid