Mantid
Loading...
Searching...
No Matches
RawFileInfo.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2009 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
9//------------------------------------
10// Includes
11//------------------------------------
12#include "MantidAPI/Algorithm.h"
13#include "MantidDataHandling/DllConfig.h"
14
15//------------------------------------
16// Forward declarations
17//------------------------------------
18class ISISRAW;
19
20namespace Mantid {
21namespace DataHandling {
46class MANTID_DATAHANDLING_DLL RawFileInfo final : public API::Algorithm {
47public:
48 static const std::string runTitle(const ISISRAW &isisRaw);
49 static const std::string runHeader(const ISISRAW &isisRaw);
51 const std::string name() const override { return "RawFileInfo"; }
53 const std::string summary() const override { return "Extract run parameters from a RAW file as output properties."; }
54
56 int version() const override { return (1); }
57 const std::vector<std::string> seeAlso() const override { return {"LoadRaw"}; }
59 const std::string category() const override { return "DataHandling\\Raw"; }
60
61private:
63 void init() override;
65 void exec() override;
66};
67} // namespace DataHandling
68} // namespace Mantid
isis raw file.
Definition: isisraw.h:272
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
An algorithm to extract pertinent information about a RAW file without loading the data.
Definition: RawFileInfo.h:46
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Definition: RawFileInfo.h:57
int version() const override
Algorithm's version.
Definition: RawFileInfo.h:56
const std::string category() const override
Algorithm's category for identification.
Definition: RawFileInfo.h:59
const std::string name() const override
Algorithm's name.
Definition: RawFileInfo.h:51
const std::string summary() const override
Summary of algorithms purpose.
Definition: RawFileInfo.h:53
Helper class which provides the Collimation Length for SANS instruments.