Load.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/Algorithm.h"
#include "MantidAPI/WorkspaceGroup_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include <mutex>
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL Load final : public API::Algorithm {
public:
  const std::string name() const override { return "Load"; }
  const std::string summary() const override {
    return "Attempts to load a given file by finding an appropriate Load "
           "algorithm.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"LoadNexus", "LoadRaw", "LoadBBY"}; }
 
  const std::string category() const override { return "DataHandling"; }
  const std::string alias() const override { return "load"; }
  void setPropertyValue(const std::string &name, const std::string &value) override;
 
protected:
  Parallel::ExecutionMode
  getParallelExecutionMode(const std::map<std::string, Parallel::StorageMode> &storageModes) const override;
 
private:
  API::IAlgorithm_sptr getFileLoader(const std::string &filePath);
  void findFilenameProperty(const API::IAlgorithm_sptr &loader);
  void declareLoaderProperties(const API::IAlgorithm_sptr &loader);
 
  void init() override;
  void exec() override;
 
  void loadSingleFile();
  void loadMultipleFiles();
 
  void cancel() override;
  API::IAlgorithm_sptr createLoader(const double startProgress = -1.0, const double endProgress = -1.0,
                                    const bool logging = true) const;
  void setUpLoader(const API::IAlgorithm_sptr &loader, const double startProgress = -1.0,
                   const double endProgress = -1.0, const bool logging = true) const;
  void setOutputProperties(const API::IAlgorithm_sptr &loader);
  API::Workspace_sptr getOutputWorkspace(const std::string &propName, const API::IAlgorithm_sptr &loader) const;
 
  API::Workspace_sptr loadFileToWs(const std::string &fileName, const std::string &wsName);
  API::Workspace_sptr plusWs(API::Workspace_sptr ws1, const API::Workspace_sptr &ws2);
  API::WorkspaceGroup_sptr groupWsList(const std::vector<API::Workspace_sptr> &wsList);
 
  std::unordered_set<std::string> m_baseProps;
  API::IAlgorithm_sptr m_loader;
  std::string m_filenamePropName;
  static std::recursive_mutex m_mutex;
};
 
} // namespace DataHandling
} // namespace Mantid