LoadInstrumentFromNexus.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 "MantidDataHandling/DllConfig.h"
 
namespace Mantid {
 
namespace Geometry {
class CompAssembly;
class Component;
class Instrument;
} // namespace Geometry
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadInstrumentFromNexus final : public API::Algorithm {
public:
  LoadInstrumentFromNexus();
 
  const std::string name() const override { return "LoadInstrumentFromNexus"; };
  const std::string summary() const override {
    return "Attempts to load some information about the instrument from a "
           "Nexus file. It adds dummy source and samplepos components to "
           "instrument. If the L1 source - sample distance is not available in "
           "the file then it may be read from the mantid properties file using "
           "the key instrument.L1, as a final fallback a default distance of "
           "10m will be used.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"LoadInstrument", "Load"}; }
 
  const std::string category() const override { return "DataHandling\\Instrument"; }
 
private:
  void init() override;
 
  void exec() override;
 
  std::string m_filename;
};
 
} // namespace DataHandling
} // namespace Mantid