LoadNexus.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidAPI/Workspace_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidKernel/Property.h"
#include <climits>
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadNexus final : public API::Algorithm {
public:
  LoadNexus();
  const std::string name() const override { return "LoadNexus"; };
  const std::string summary() const override {
    return "The LoadNexus algorithm will try to identify the type of Nexus "
           "file given to it and invoke the appropriate algorithm to read the "
           "data and populate the named workspace.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"LoadMcStasNexus",    "LoadNexusMonitors", "LoadNexusProcessed", "LoadTOFRawNexus",
            "LoadILLDiffraction", "LoadILLTOF",        "LoadILLIndirect",    "LoadILLReflectometry",
            "LoadILLSANS",        "LoadMuonNexus",     "LoadFlexiNexus"};
  }
  const std::string category() const override { return "DataHandling\\Nexus"; }
 
  static const std::string muonTD;
  static const std::string pulsedTD;
 
  static int getNexusEntryTypes(const std::string &fileName, std::vector<std::string> &entryName,
                                std::vector<std::string> &definition);
 
private:
  void init() override;
 
  void exec() override;
 
  std::string m_filename;
 
  std::string m_workspace;
 
  void runLoadMuonNexus();
 
  void runLoadIsisNexus();
 
  void runLoadNexusProcessed();
 
  void runLoadTOFRawNexus();
 
  void setOutputWorkspace(const API::IAlgorithm_sptr &loader);
};
} // namespace DataHandling
} // namespace Mantid