Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Mantid::API::DeprecatedAlgorithm Class Reference

Class for marking algorithms as deprecated. More...

#include <DeprecatedAlgorithm.h>

Inheritance diagram for Mantid::API::DeprecatedAlgorithm:
Mantid::Algorithms::AddNote Mantid::Algorithms::AlignDetectors Mantid::Algorithms::CheckWorkspacesMatch Mantid::Algorithms::ConvertEmptyToTof Mantid::Algorithms::ConvertUnitsUsingDetectorTable Mantid::Algorithms::DiffractionFocussing Mantid::Algorithms::FFTSmooth Mantid::Algorithms::MaskInstrument Mantid::Algorithms::RecordPythonScript Mantid::Crystal::FindUBUsingMinMaxD Mantid::CurveFitting::Algorithms::RefinePowderInstrumentParameters Mantid::DataHandling::FilterEventsByLogValuePreNexus Mantid::DataHandling::LoadAscii Mantid::DataHandling::LoadNexusMonitors Mantid::DataHandling::LoadSINQFocus Mantid::DataHandling::LoadSNSspec Mantid::DataHandling::SaveDiffFittingAscii Mantid::MDAlgorithms::CentroidPeaksMD Mantid::MDAlgorithms::EvaluateMDFunction

Public Member Functions

 DeprecatedAlgorithm ()
 Does nothing other than make the compiler happy. More...
 
void deprecatedDate (const std::string &)
 The date the algorithm was deprecated on. More...
 
std::string deprecationMsg (const IAlgorithm *)
 This merely prints the deprecation error for people to see. More...
 
void useAlgorithm (const std::string &, const int version=-1)
 The algorithm to use instead of this one. More...
 
virtual ~DeprecatedAlgorithm ()
 Does nothing other than make the compiler happy. More...
 

Private Attributes

std::string m_deprecatedDate
 The date that the algorithm was first deprecated. More...
 
std::string m_replacementAlgorithm
 The algorithm to use instead of this one. More...
 
int m_replacementVersion
 Replacement version, -1 indicates latest. More...
 

Detailed Description

Class for marking algorithms as deprecated.

Author
Peter Peterson, NScD Oak Ridge National Laboratory
Date
25/02/2011

Definition at line 23 of file DeprecatedAlgorithm.h.

Constructor & Destructor Documentation

◆ DeprecatedAlgorithm()

Mantid::API::DeprecatedAlgorithm::DeprecatedAlgorithm ( )

Does nothing other than make the compiler happy.

Definition at line 20 of file DeprecatedAlgorithm.cpp.

◆ ~DeprecatedAlgorithm()

Mantid::API::DeprecatedAlgorithm::~DeprecatedAlgorithm ( )
virtualdefault

Does nothing other than make the compiler happy.

Member Function Documentation

◆ deprecatedDate()

void Mantid::API::DeprecatedAlgorithm::deprecatedDate ( const std::string &  date)

◆ deprecationMsg()

std::string Mantid::API::DeprecatedAlgorithm::deprecationMsg ( const IAlgorithm algo)

◆ useAlgorithm()

void Mantid::API::DeprecatedAlgorithm::useAlgorithm ( const std::string &  replacement,
const int  version = -1 
)

The algorithm to use instead of this one.

Parameters
replacementName of the algorithm that replaces the deprecated one
versionAn optional version number for the replacement (default=-1)

Definition at line 28 of file DeprecatedAlgorithm.cpp.

References m_replacementAlgorithm, and m_replacementVersion.

Referenced by Mantid::Algorithms::AlignDetectors::AlignDetectors(), Mantid::MDAlgorithms::CentroidPeaksMD::CentroidPeaksMD(), Mantid::Crystal::FindUBUsingMinMaxD::FindUBUsingMinMaxD(), Mantid::DataHandling::LoadAscii::LoadAscii(), Mantid::DataHandling::LoadSNSspec::LoadSNSspec(), and Mantid::Algorithms::RecordPythonScript::RecordPythonScript().

Member Data Documentation

◆ m_deprecatedDate

std::string Mantid::API::DeprecatedAlgorithm::m_deprecatedDate
private

The date that the algorithm was first deprecated.

Definition at line 39 of file DeprecatedAlgorithm.h.

Referenced by deprecatedDate(), and deprecationMsg().

◆ m_replacementAlgorithm

std::string Mantid::API::DeprecatedAlgorithm::m_replacementAlgorithm
private

The algorithm to use instead of this one.

Definition at line 35 of file DeprecatedAlgorithm.h.

Referenced by deprecationMsg(), and useAlgorithm().

◆ m_replacementVersion

int Mantid::API::DeprecatedAlgorithm::m_replacementVersion
private

Replacement version, -1 indicates latest.

Definition at line 37 of file DeprecatedAlgorithm.h.

Referenced by deprecationMsg(), and useAlgorithm().


The documentation for this class was generated from the following files: