LoadInstrument.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 "MantidDataHandling/DllConfig.h"
 
namespace Poco {
namespace XML {
class Element;
}
} // namespace Poco
 
namespace Mantid {
namespace API {
class MatrixWorkspace;
}
namespace Geometry {
class CompAssembly;
class Component;
class CSGObject;
class ObjComponent;
class Instrument;
} // namespace Geometry
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL LoadInstrument : public API::Algorithm {
public:
  const std::string name() const override { return "LoadInstrument"; };
  const std::string summary() const override {
    return "Loads an Instrument Definition File (IDF) into a workspace. After "
           "the IDF has been read this algorithm will attempt to run the Child "
           "Algorithm LoadParameterFile; where if IDF filename is of the form "
           "IDENTIFIER_Definition.xml then the instrument parameters in the "
           "file named IDENTIFIER_Parameters.xml would be loaded.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"LoadInstrumentFromNexus", "LoadInstrumentFromRaw", "ExportGeometry", "Load"};
  }
  const std::string category() const override { return "DataHandling\\Instrument"; }
 
private:
  void init() override;
  void exec() override;
 
  void runLoadParameterFile(const std::shared_ptr<API::MatrixWorkspace> &ws);
 
  static std::recursive_mutex m_mutex;
};
 
} // namespace DataHandling
} // namespace Mantid