Mantid
Loading...
Searching...
No Matches
PatchBBY.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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
13#include "LoadANSTOHelper.h"
15#include "MantidDataHandling/DllConfig.h"
18
19namespace Mantid {
20namespace DataHandling {
21/*
22Patches a Bilby data file. Implements API::Algorithm and its file check methods
23to recognise a file as the one containing Bilby data.
24
25@author David Mannicke (ANSTO), Anders Markvardsen (ISIS), Roman Tolchenov
26(Tessella plc)
27@date 22/01/2016
28*/
29
30class MANTID_DATAHANDLING_DLL PatchBBY final : public API::Algorithm {
31public:
32 // description
33 int version() const override { return 1; }
34 const std::vector<std::string> seeAlso() const override { return {"LoadBBY"}; }
35 const std::string name() const override { return "PatchBBY"; }
36 const std::string category() const override { return "DataHandling\\ANSTO"; }
37 const std::string summary() const override { return "Patches a BilBy data file."; }
38
39protected:
40 // initialisation
41 void init() override;
42 // execution
43 void exec() override;
44};
45
46} // namespace DataHandling
47} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
const std::string category() const override
function to return a category of the algorithm.
Definition PatchBBY.h:36
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms
Definition PatchBBY.h:35
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
Definition PatchBBY.h:33
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
Definition PatchBBY.h:37
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 PatchBBY.h:34
Helper class which provides the Collimation Length for SANS instruments.