Mantid
Loading...
Searching...
No Matches
DeprecatedAlgorithm.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 "MantidAPI/DllConfig.h"
12#include <string>
13
14namespace Mantid {
15namespace API {
16
23class MANTID_API_DLL DeprecatedAlgorithm {
24public:
27 std::string deprecationMsg(const IAlgorithm *);
28
29public:
30 void useAlgorithm(const std::string &, const int version = -1);
31 void deprecatedDate(const std::string &);
32
33private:
39 std::string m_deprecatedDate;
40};
41
42} // namespace API
43} // namespace Mantid
Class for marking algorithms as deprecated.
std::string m_deprecatedDate
The date that the algorithm was first deprecated.
std::string m_replacementAlgorithm
The algorithm to use instead of this one.
virtual ~DeprecatedAlgorithm()
Does nothing other than make the compiler happy.
int m_replacementVersion
Replacement version, -1 indicates latest.
IAlgorithm is the interface implemented by the Algorithm base class.
Definition: IAlgorithm.h:45
Helper class which provides the Collimation Length for SANS instruments.