LoadSampleEnvironment.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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/Run.h"
#include "MantidAPI/Sample.h"
#include "MeshFileIO.h"
 
namespace Mantid {
namespace Geometry {
class MeshObject;
}
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadSampleEnvironment : public Mantid::API::Algorithm {
public:
  const std::string name() const override { return "LoadSampleEnvironment"; }
  const std::string summary() const override {
    return "The algorithm loads an Environment into the instrument of a "
           "workspace "
           "at the sample.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override {
    return {"CopySample", "SetSampleMaterial", "LoadSampleShape"};
  }
  const std::string category() const override { return "DataHandling\\Instrument"; }
  std::map<std::string, std::string> validateInputs() override;
 
private:
  // Implement abstract Algorithm methods
  void init() override;
  void exec() override;
 
  void loadEnvironmentFromSTL(const std::string &filename, API::Sample &sample, const bool add,
                              std::string debugString);
 
  void loadEnvironmentFrom3MF([[maybe_unused]] const API::MatrixWorkspace_const_sptr &inputWS,
                              [[maybe_unused]] const std::string &filename, [[maybe_unused]] API::Sample &sample,
                              [[maybe_unused]] const bool add, std::string &debugString);
};
 
} // end namespace DataHandling
} // namespace Mantid