From 4da3969aab1be73966c14b59680c9b3c3172ee2b Mon Sep 17 00:00:00 2001
From: Felix Weiglhofer <weiglhofer@fias.uni-frankfurt.de>
Date: Fri, 9 Jun 2023 15:45:56 +0000
Subject: [PATCH] algo: Rename StsReadoutConfig to StsReadoutConfigLegacy.

---
 algo/CMakeLists.txt                            |  2 +-
 ...utConfig.cxx => StsReadoutConfigLegacy.cxx} | 18 +++++++++---------
 ...eadoutConfig.h => StsReadoutConfigLegacy.h} | 16 ++++++++--------
 algo/detectors/sts/UnpackStsXpu.cxx            |  2 +-
 algo/detectors/sts/UnpackStsXpu.h              |  4 ++--
 reco/mq/CbmDevUnpack.h                         |  6 +++---
 reco/tasks/CbmTaskUnpack.h                     |  4 ++--
 reco/tasks/CbmTaskUnpackXpu.h                  |  4 ++--
 8 files changed, 28 insertions(+), 28 deletions(-)
 rename algo/detectors/sts/{StsReadoutConfig.cxx => StsReadoutConfigLegacy.cxx} (94%)
 rename algo/detectors/sts/{StsReadoutConfig.h => StsReadoutConfigLegacy.h} (80%)

diff --git a/algo/CMakeLists.txt b/algo/CMakeLists.txt
index 52ee1cb109..2f8182f323 100644
--- a/algo/CMakeLists.txt
+++ b/algo/CMakeLists.txt
@@ -19,7 +19,7 @@ set(SRCS
   evselector/DigiEventSelector.cxx
   detectors/sts/ReadoutConfig.cxx
   detectors/sts/StsHitfinderChain.cxx
-  detectors/sts/StsReadoutConfig.cxx
+  detectors/sts/StsReadoutConfigLegacy.cxx
   detectors/sts/StsUnpackChain.cxx
   detectors/sts/UnpackSts.cxx
   detectors/much/MuchReadoutConfig.cxx
diff --git a/algo/detectors/sts/StsReadoutConfig.cxx b/algo/detectors/sts/StsReadoutConfigLegacy.cxx
similarity index 94%
rename from algo/detectors/sts/StsReadoutConfig.cxx
rename to algo/detectors/sts/StsReadoutConfigLegacy.cxx
index 809a20fa45..34f41eaef2 100644
--- a/algo/detectors/sts/StsReadoutConfig.cxx
+++ b/algo/detectors/sts/StsReadoutConfigLegacy.cxx
@@ -2,7 +2,7 @@
    SPDX-License-Identifier: GPL-3.0-only
    Authors: Volker Friese [committer] */
 
-#include "StsReadoutConfig.h"
+#include "StsReadoutConfigLegacy.h"
 
 #include "CbmStsAddress.h"
 
@@ -17,17 +17,17 @@ namespace cbm::algo
 
 
   // ---  Constructor  ------------------------------------------------------------------
-  StsReadoutConfig::StsReadoutConfig() { Init(); }
+  StsReadoutConfigLegacy::StsReadoutConfigLegacy() { Init(); }
   // ------------------------------------------------------------------------------------
 
 
   // ---   Destructor   -----------------------------------------------------------------
-  StsReadoutConfig::~StsReadoutConfig() {}
+  StsReadoutConfigLegacy::~StsReadoutConfigLegacy() {}
   // ------------------------------------------------------------------------------------
 
 
   // ---   Equipment IDs   --------------------------------------------------------------
-  std::vector<uint16_t> StsReadoutConfig::GetEquipmentIds()
+  std::vector<uint16_t> StsReadoutConfigLegacy::GetEquipmentIds()
   {
     std::vector<uint16_t> result;
     for (auto& entry : fReadoutMap)
@@ -38,7 +38,7 @@ namespace cbm::algo
 
 
   // ---   Number of elinks for a component / equipment   -------------------------------
-  size_t StsReadoutConfig::GetNumElinks(uint16_t equipmentId)
+  size_t StsReadoutConfigLegacy::GetNumElinks(uint16_t equipmentId)
   {
     size_t result = 0;
     auto it       = fReadoutMap.find(equipmentId);
@@ -49,7 +49,7 @@ namespace cbm::algo
 
 
   // ---   Total number of elinks for STS   ---------------------------------------------
-  size_t StsReadoutConfig::GetNumElinks()
+  size_t StsReadoutConfigLegacy::GetNumElinks()
   {
     size_t result = 0;
     for (auto& entry : fReadoutMap) {
@@ -61,7 +61,7 @@ namespace cbm::algo
 
 
   // ---  Initialise the mapping structure   --------------------------------------------
-  void StsReadoutConfig::Init()
+  void StsReadoutConfigLegacy::Init()
   {
 
     // This here refers to the mCBM 2021 setup.
@@ -184,7 +184,7 @@ namespace cbm::algo
 
 
   // ---  Mapping (equimentId, elink) -> (address, ASIC)  --------------------------------
-  pair<int32_t, uint16_t> StsReadoutConfig::Map(uint16_t equipmentId, uint16_t elinkId)
+  pair<int32_t, uint16_t> StsReadoutConfigLegacy::Map(uint16_t equipmentId, uint16_t elinkId)
   {
     std::pair<int32_t, uint16_t> result(-1, 0);
     auto equipIter = fReadoutMap.find(equipmentId);
@@ -197,7 +197,7 @@ namespace cbm::algo
 
 
   // -----   Print readout map   ------------------------------------------------
-  std::string StsReadoutConfig::PrintReadoutMap()
+  std::string StsReadoutConfigLegacy::PrintReadoutMap()
   {
 
     std::stringstream ss;
diff --git a/algo/detectors/sts/StsReadoutConfig.h b/algo/detectors/sts/StsReadoutConfigLegacy.h
similarity index 80%
rename from algo/detectors/sts/StsReadoutConfig.h
rename to algo/detectors/sts/StsReadoutConfigLegacy.h
index b6480d5c87..ef452d3eb8 100644
--- a/algo/detectors/sts/StsReadoutConfig.h
+++ b/algo/detectors/sts/StsReadoutConfigLegacy.h
@@ -2,8 +2,8 @@
    SPDX-License-Identifier: GPL-3.0-only
    Authors: Volker Friese [committer] */
 
-#ifndef ALGO_DETECTORS_STS_STSREADOUTCONFIG_H
-#define ALGO_DETECTORS_STS_STSREADOUTCONFIG_H
+#ifndef ALGO_DETECTORS_STS_StsReadoutConfigLegacy_H
+#define ALGO_DETECTORS_STS_StsReadoutConfigLegacy_H
 
 #include <map>
 #include <sstream>
@@ -14,7 +14,7 @@ namespace cbm::algo
 {
 
 
-  /** @class StsReadoutConfig
+  /** @class StsReadoutConfigLegacy
    ** @author Volker Friese <v.friese@gsi.de>
    ** @since 3 March 2022
    ** @brief Provides the hardware-to-software address mapping for the CBM-STS
@@ -25,18 +25,18 @@ namespace cbm::algo
    ** the module.
    ** The mapping of the two address spaces is hard-coded in this class.
    **
-   ** NOTE: This class is deprecated. It's replaced by ReadoutMapping in algo/data/sts. The new class no longer hardcodes the mapping. It can be read from a configuration file instead.
+   ** NOTE: This class is deprecated. It's replaced by ReadoutConfig in detector/sts. The new class no longer hardcodes the mapping. It can be read from a configuration file instead.
    **/
 
-  class StsReadoutConfig {
+  class StsReadoutConfigLegacy {
 
   public:
     /** @brief Constructor **/
-    StsReadoutConfig();
+    StsReadoutConfigLegacy();
 
 
     /** @brief Destructor **/
-    virtual ~StsReadoutConfig();
+    virtual ~StsReadoutConfigLegacy();
 
 
     /** @brief Equipment in the configuration
@@ -82,4 +82,4 @@ namespace cbm::algo
 
 } /* namespace cbm::algo */
 
-#endif /* ALGO_DETECTORS_STS_STSREADOUTCONFIG_H_ */
+#endif /* ALGO_DETECTORS_STS_StsReadoutConfigLegacy_H_ */
diff --git a/algo/detectors/sts/UnpackStsXpu.cxx b/algo/detectors/sts/UnpackStsXpu.cxx
index 6d8f3aabb5..5339ccb56c 100644
--- a/algo/detectors/sts/UnpackStsXpu.cxx
+++ b/algo/detectors/sts/UnpackStsXpu.cxx
@@ -95,7 +95,7 @@ XPU_KERNEL(cbm::algo::UnpackK, xpu::no_smem, UnpackStsXpuPar* params, UnpackStsX
 namespace cbm::algo
 {
   // ----   Algorithm execution   ---------------------------------------------
-  UnpackStsXpu::resultType UnpackStsXpu::operator()(const fles::Timeslice* ts, StsReadoutConfig& config)
+  UnpackStsXpu::resultType UnpackStsXpu::operator()(const fles::Timeslice* ts, StsReadoutConfigLegacy& config)
   {
     // --- Output data
     resultType result = {};
diff --git a/algo/detectors/sts/UnpackStsXpu.h b/algo/detectors/sts/UnpackStsXpu.h
index acd7857e56..d021fbee86 100644
--- a/algo/detectors/sts/UnpackStsXpu.h
+++ b/algo/detectors/sts/UnpackStsXpu.h
@@ -20,7 +20,7 @@
 #include <xpu/device.h>
 #include <xpu/host.h>
 
-#include "StsReadoutConfig.h"
+#include "StsReadoutConfigLegacy.h"
 #include "StsXyterMessage.h"
 #include "gpu/DeviceImage.h"
 #include "gpu/xpu_legacy.h"
@@ -104,7 +104,7 @@ namespace cbm::algo
      ** @param  config  Configuration data
      ** @return STS digi data
      **/
-    resultType operator()(const fles::Timeslice* ts, StsReadoutConfig& config);
+    resultType operator()(const fles::Timeslice* ts, StsReadoutConfigLegacy& config);
 
     //Stores parameter structs for all elinks
     xpu::hd_buffer<UnpackStsXpuElinkPar> fElinkParams;
diff --git a/reco/mq/CbmDevUnpack.h b/reco/mq/CbmDevUnpack.h
index 454dd13964..fb0fb2c0ca 100644
--- a/reco/mq/CbmDevUnpack.h
+++ b/reco/mq/CbmDevUnpack.h
@@ -27,7 +27,7 @@
 #include <vector>
 
 #include "MuchReadoutConfig.h"
-#include "StsReadoutConfig.h"
+#include "StsReadoutConfigLegacy.h"
 #include "UnpackMuch.h"
 #include "UnpackSts.h"
 
@@ -41,7 +41,7 @@ public:
 
 private:
   std::map<uint16_t, cbm::algo::UnpackSts> fAlgoSts = {};
-  cbm::algo::StsReadoutConfig fStsConfig {};
+  cbm::algo::StsReadoutConfigLegacy fStsConfig {};
 
   std::map<uint16_t, cbm::algo::UnpackMuch> fAlgoMuch = {};
   cbm::algo::MuchReadoutConfig fMuchConfig {};
@@ -65,7 +65,7 @@ private:
   bool InitAlgos();
 
   /**
-   * @brief Unpack a single timeslice 
+   * @brief Unpack a single timeslice
    * @param ts Input FLES timeslice
   */
   CbmDigiTimeslice DoUnpack(const fles::Timeslice& ts);
diff --git a/reco/tasks/CbmTaskUnpack.h b/reco/tasks/CbmTaskUnpack.h
index 70c3fa8999..e686a2c816 100644
--- a/reco/tasks/CbmTaskUnpack.h
+++ b/reco/tasks/CbmTaskUnpack.h
@@ -21,7 +21,7 @@
 #include "BmonReadoutConfig.h"
 #include "EventBuilder.h"
 #include "MuchReadoutConfig.h"
-#include "StsReadoutConfig.h"
+#include "StsReadoutConfigLegacy.h"
 #include "UnpackBmon.h"
 #include "UnpackMuch.h"
 #include "UnpackSts.h"
@@ -86,7 +86,7 @@ private:  // members
   CbmSourceTs* fSource = nullptr;
 
   std::map<uint16_t, cbm::algo::UnpackSts> fAlgoSts = {};
-  cbm::algo::StsReadoutConfig fStsConfig {};
+  cbm::algo::StsReadoutConfigLegacy fStsConfig {};
 
   std::map<uint16_t, cbm::algo::UnpackMuch> fAlgoMuch = {};
   cbm::algo::MuchReadoutConfig fMuchConfig {};
diff --git a/reco/tasks/CbmTaskUnpackXpu.h b/reco/tasks/CbmTaskUnpackXpu.h
index fe51c61dae..95045c7e24 100644
--- a/reco/tasks/CbmTaskUnpackXpu.h
+++ b/reco/tasks/CbmTaskUnpackXpu.h
@@ -15,7 +15,7 @@
 #include <vector>
 
 #include "EventBuilder.h"
-#include "StsReadoutConfig.h"
+#include "StsReadoutConfigLegacy.h"
 #include "UnpackStsXpu.h"
 
 
@@ -70,7 +70,7 @@ private:  // members
   CbmSourceTs* fSource = nullptr;
 
   cbm::algo::UnpackStsXpu fAlgoStsXpu;
-  cbm::algo::StsReadoutConfig fStsConfig {};
+  cbm::algo::StsReadoutConfigLegacy fStsConfig {};
 
   size_t fNumTs                = 0;
   size_t fNumMs                = 0;
-- 
GitLab