Deprecate LoadDspacemap - Sibling (#38020)

* Deprecate and add note * Rename release note * Remove CppCheck suppression * Correct date Co-authored-by: Pete Peterson <[email protected]> --------- Co-authored-by: Pete Peterson <[email protected]>
mantidproject · Sep 18, 2024 · b157e07 · b157e07
1 parent 1a96441
commit b157e07
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadDspacemap.h b/Framework/DataHandling/inc/MantidDataHandling/LoadDspacemap.h
@@ -7,6 +7,7 @@
 #pragma once
 
 #include "MantidAPI/Algorithm.h"
+#include "MantidAPI/DeprecatedAlgorithm.h"
 #include "MantidAPI/MatrixWorkspace_fwd.h"
 #include "MantidDataHandling/DllConfig.h"
 #include "MantidDataObjects/OffsetsWorkspace.h"
@@ -22,8 +23,10 @@ namespace DataHandling {
  * @author Janik Zikovsky (code from Vickie Lynch)
  * @date 2011-05-10
  */
-class MANTID_DATAHANDLING_DLL LoadDspacemap final : public API::Algorithm {
+class MANTID_DATAHANDLING_DLL LoadDspacemap final : public API::Algorithm, public API::DeprecatedAlgorithm {
 public:
+  LoadDspacemap();
+
   /// Algorithm's name for identification
   const std::string name() const override { return "LoadDspacemap"; };
   /// Summary of algorithms purpose

diff --git a/Framework/DataHandling/src/LoadDspacemap.cpp b/Framework/DataHandling/src/LoadDspacemap.cpp
@@ -28,6 +28,8 @@ namespace Mantid::DataHandling {
 // Register the algorithm into the AlgorithmFactory
 DECLARE_ALGORITHM(LoadDspacemap)
 
+LoadDspacemap::LoadDspacemap() { this->deprecatedDate("2024-09-17"); }
+
 //----------------------------------------------------------------------------------------------
 /** Initialize the algorithm's properties.
  */
@@ -339,7 +341,7 @@ struct VulcanCorrectionFactor {
 void LoadDspacemap::readVulcanBinaryFile(const std::string &fileName, std::map<detid_t, double> &vulcan) {
   BinaryFile<VulcanCorrectionFactor> file(fileName);
   std::vector<VulcanCorrectionFactor> results = file.loadAll();
-  for (auto &result : results) {
+  for (const auto &result : results) {
     vulcan[static_cast<detid_t>(result.pixelID)] = result.factor;
   }
 }

diff --git a/buildconfig/CMake/CppCheck_Suppressions.txt.in b/buildconfig/CMake/CppCheck_Suppressions.txt.in
@@ -643,7 +643,6 @@ duplicateConditionalAssign:${CMAKE_SOURCE_DIR}/Framework/DataHandling/src/LoadCa
 constParameterPointer:${CMAKE_SOURCE_DIR}/Framework/DataHandling/src/LoadCalFile.cpp:57
 uselessOverride:${CMAKE_SOURCE_DIR}/Framework/DataHandling/inc/MantidDataHandling/LoadDNSEvent.h:44
 passedByValue:${CMAKE_SOURCE_DIR}/Framework/DataHandling/inc/MantidDataHandling/BitStream.h:30
-constVariableReference:${CMAKE_SOURCE_DIR}/Framework/DataHandling/src/LoadDspacemap.cpp:342
 cstyleCast:${CMAKE_SOURCE_DIR}/Framework/DataHandling/src/LoadANSTOHelper.cpp:210
 variableScope:${CMAKE_SOURCE_DIR}/Framework/DataHandling/src/DetermineChunking.cpp:163
 unreadVariable:${CMAKE_SOURCE_DIR}/Framework/DataHandling/src/LoadANSTOHelper.cpp:436

diff --git a/docs/source/release/v6.12.0/Framework/Data_Handling/New_features/38013.rst b/docs/source/release/v6.12.0/Framework/Data_Handling/New_features/38013.rst
@@ -0,0 +1 @@
+- :ref:`LoadDspacemap <algm-LoadDspacemap>` has been deprecated.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		- :ref:`LoadDspacemap <algm-LoadDspacemap>` has been deprecated.