DeprecatedAlias : Class for making algorithm with deprecated names (aliases). More...
#include <DeprecatedAlias.h>
Public Member Functions | |
| DeprecatedAlias () | |
| Constructor to ensure the compiler is happy. More... | |
| std::string | deprecationMessage (const IAlgorithm *) |
| Construct and return a full deprecation message. More... | |
| void | setDeprecationDate (const std::string &date) |
| Set the deprecation date which will be used to inform the users. More... | |
| virtual | ~DeprecatedAlias () |
| Destructor to ensure the compiler is happy. More... | |
Private Attributes | |
| std::string | m_deprecationDate |
| Deprecation date. More... | |
Detailed Description
DeprecatedAlias : Class for making algorithm with deprecated names (aliases).
This class will ensure that if an algorithm is invoke with a deprecated name,
- a warning will be throw to inform the users that
- the algorithm name is deprecated
- the deprecation date
- the new algorithm name the user is recommended to use instead
All algorithms with deprecated alias need to inherit from this class.
The recommended algorithm naming pattern should be [Technique][Facility/Instrument]ActionTarget For example: the calibration routine of panel detector for single crystal diffraction beamline can be named as SCDCalibratePanels
Definition at line 33 of file DeprecatedAlias.h.
Constructor & Destructor Documentation
◆ DeprecatedAlias()
| Mantid::API::DeprecatedAlias::DeprecatedAlias | ( | ) |
Constructor to ensure the compiler is happy.
Definition at line 20 of file DeprecatedAlias.cpp.
◆ ~DeprecatedAlias()
|
virtualdefault |
Destructor to ensure the compiler is happy.
Member Function Documentation
◆ deprecationMessage()
| std::string Mantid::API::DeprecatedAlias::deprecationMessage | ( | const IAlgorithm * | algo | ) |
Construct and return a full deprecation message.
- Parameters
-
algo
- Returns
- std::string
Definition at line 45 of file DeprecatedAlias.cpp.
References Mantid::API::IAlgorithm::alias(), m_deprecationDate, and Mantid::API::IAlgorithm::name().
◆ setDeprecationDate()
| void Mantid::API::DeprecatedAlias::setDeprecationDate | ( | const std::string & | date | ) |
Set the deprecation date which will be used to inform the users.
- Parameters
-
date : deprecation date in ISO8601 format
Definition at line 30 of file DeprecatedAlias.cpp.
References m_deprecationDate.
Member Data Documentation
◆ m_deprecationDate
|
private |
Deprecation date.
Definition at line 42 of file DeprecatedAlias.h.
Referenced by deprecationMessage(), and setDeprecationDate().
The documentation for this class was generated from the following files:
- Framework/API/inc/MantidAPI/DeprecatedAlias.h
- Framework/API/src/DeprecatedAlias.cpp
