Mantid
Loading...
Searching...
No Matches
LoadParameterFile.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidDataHandling/DllConfig.h"
11
13namespace Poco {
14namespace XML {
15class Element;
16}
17} // namespace Poco
19
20namespace Mantid {
21namespace Geometry {
22class CompAssembly;
23class Component;
24class CSGObject;
25class ObjComponent;
26class Instrument;
27} // namespace Geometry
28
29namespace DataHandling {
48class MANTID_DATAHANDLING_DLL LoadParameterFile : public API::Algorithm {
49public:
51 const std::string name() const override { return "LoadParameterFile"; };
53 const std::string summary() const override {
54 return "Loads instrument parameters into a workspace. where these "
55 "parameters are associated component names as defined in Instrument "
56 "Definition File (IDF) or a string consisting of the contents of "
57 "such.";
58 }
59
61 int version() const override { return 1; };
62 const std::vector<std::string> seeAlso() const override { return {"SaveParameterFile"}; }
64 const std::string category() const override { return "DataHandling\\Instrument"; }
65
66private:
67 void init() override;
68 void exec() override;
69};
70} // namespace DataHandling
71} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
DataHandling/LoadParameterFile.h.
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
int version() const override
Algorithm's version for identification overriding a virtual method.
Helper class which provides the Collimation Length for SANS instruments.