Merge pull request #56 from DUNE-DAQ/aeoranday/factory-abstraction

TA & TC Factory Method Abstraction
DUNE-DAQ · Jan 19, 2024 · dad9e4d · dad9e4d
2 parents 5458de3 + 37d95b9
commit dad9e4d
Show file tree

Hide file tree

Showing 26 changed files with 168 additions and 87 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -52,7 +52,6 @@ add_library(triggeralgs SHARED
   src/TPWindow.cpp
   src/dbscan/dbscan.cpp
   src/dbscan/Hit.cpp
-  src/TriggerActivityFactory.cpp
   )
 
 target_include_directories(triggeralgs PUBLIC

diff --git a/include/triggeralgs/ADCSimpleWindow/TriggerActivityMakerADCSimpleWindow.hpp b/include/triggeralgs/ADCSimpleWindow/TriggerActivityMakerADCSimpleWindow.hpp
@@ -9,7 +9,6 @@
 #ifndef TRIGGERALGS_ADCSIMPLEWINDOW_TRIGGERACTIVITYMAKERADCSIMPLEWINDOW_HPP_
 #define TRIGGERALGS_ADCSIMPLEWINDOW_TRIGGERACTIVITYMAKERADCSIMPLEWINDOW_HPP_
 
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 #include "triggeralgs/Types.hpp"
 

diff --git a/include/triggeralgs/ADCSimpleWindow/TriggerCandidateMakerADCSimpleWindow.hpp b/include/triggeralgs/ADCSimpleWindow/TriggerCandidateMakerADCSimpleWindow.hpp
@@ -9,7 +9,7 @@
 #ifndef TRIGGERALGS_ADCSIMPLEWINDOW_TRIGGERCANDIDATEMAKERADCSIMPLEWINDOW_HPP_
 #define TRIGGERALGS_ADCSIMPLEWINDOW_TRIGGERCANDIDATEMAKERADCSIMPLEWINDOW_HPP_
 
-#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/TriggerCandidateFactory.hpp"
 
 #include <vector>
 

diff --git a/include/triggeralgs/AbstractFactory.hpp b/include/triggeralgs/AbstractFactory.hpp
@@ -0,0 +1,49 @@
+/* @file: AbstractFactory.hpp
+ *
+ * This is part of the DUNE DAQ Application Framework, copyright 2023.
+ * Licensing/copyright details are in the COPYING file that you should have
+ * received with this code.
+ */
+
+#ifndef TRIGGERALGS_ABSTRACT_FACTORY_HPP_
+#define TRIGGERALGS_ABSTRACT_FACTORY_HPP_
+
+#include "logging/Logging.hpp"
+
+#include <functional>
+#include <memory>
+#include <string>
+#include <unordered_map>
+
+namespace triggeralgs {
+
+template <typename T>
+class AbstractFactory
+{
+  using maker_creator = std::function<std::unique_ptr<T>()>;
+  using creation_map = std::unordered_map<std::string, maker_creator>;
+
+  public:
+    AbstractFactory() {}
+    AbstractFactory(const AbstractFactory&) = delete;
+    AbstractFactory& operator=(const AbstractFactory&) = delete;
+    virtual ~AbstractFactory() {}
+
+    std::unique_ptr<T> build_maker(const std::string& alg_name);
+
+    static void register_creator(const std::string alg_name, maker_creator creator);
+
+    static std::shared_ptr<AbstractFactory<T>> get_instance();
+
+  protected:
+    static std::shared_ptr<AbstractFactory<T>> s_single_factory;
+
+  private:
+    static creation_map& get_makers();
+};
+
+} /* namespace triggeralgs */
+
+#include "triggeralgs/AbstractFactory.hxx"
+
+#endif // TRIGGERALGS_ABSTRACT_FACTORY_HPP_
diff --git a/include/triggeralgs/AbstractFactory.hxx b/include/triggeralgs/AbstractFactory.hxx
@@ -0,0 +1,63 @@
+/* @file: AbstractFactory.hxx
+ *
+ * This is part of the DUNE DAQ Application Framework, copyright 2023.
+ * Licensing/copyright details are in the COPYING file that you should have
+ * received with this code.
+ */
+
+#ifndef TRIGGERALGS_ABSTRACT_FACTORY_HXX_
+#define TRIGGERALGS_ABSTRACT_FACTORY_HXX_
+
+namespace triggeralgs {
+
+template <typename T>
+std::shared_ptr<AbstractFactory<T>> AbstractFactory<T>::s_single_factory = nullptr;
+
+template <typename T>
+typename AbstractFactory<T>::creation_map& AbstractFactory<T>::get_makers(){
+  static creation_map s_makers;
+  return s_makers;
+}
+
+template <typename T>
+void AbstractFactory<T>::register_creator(const std::string alg_name, maker_creator creator)
+{
+  creation_map& makers = get_makers();
+  auto it = makers.find(alg_name);
+
+  if (it == makers.end()) {
+    makers[alg_name] = creator;
+    return;
+  }
+  TLOG(0) << "Attempted to overwrite a creator in factory with " << alg_name << ".";
+  throw; // creators should not be overwritten.
+  return;
+}
+
+template <typename T>
+std::unique_ptr<T> AbstractFactory<T>::build_maker(const std::string& alg_name)
+{
+  creation_map& makers = get_makers();
+  auto it = makers.find(alg_name);
+
+  if (it != makers.end()) {
+    TLOG(0) << "Factory building " << alg_name << ".";
+    return it->second();
+  }
+
+  TLOG(0) << "Factory couldn't find " << alg_name << ".";
+  return nullptr;
+}
+
+template <typename T>
+std::shared_ptr<AbstractFactory<T>> AbstractFactory<T>::get_instance()
+{
+  if (s_single_factory == nullptr) {
+    s_single_factory = std::make_shared<AbstractFactory<T>>();
+  }
+  return s_single_factory;
+}
+
+} // namespace triggeralgs
+
+#endif // TRIGGERALGS_ABSTRACT_FACTORY_HXX_
diff --git a/include/triggeralgs/HorizontalMuon/TriggerActivityMakerHorizontalMuon.hpp b/include/triggeralgs/HorizontalMuon/TriggerActivityMakerHorizontalMuon.hpp
@@ -9,7 +9,6 @@
 #ifndef TRIGGERALGS_HORIZONTALMUON_TRIGGERACTIVITYMAKERHORIZONTALMUON_HPP_
 #define TRIGGERALGS_HORIZONTALMUON_TRIGGERACTIVITYMAKERHORIZONTALMUON_HPP_
 
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TPWindow.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 #include <fstream>

diff --git a/include/triggeralgs/HorizontalMuon/TriggerCandidateMakerHorizontalMuon.hpp b/include/triggeralgs/HorizontalMuon/TriggerCandidateMakerHorizontalMuon.hpp
@@ -9,7 +9,7 @@
 #ifndef TRIGGERALGS_HORIZONTALMUON_TRIGGERCANDIDATEMAKERHORIZONTALMUON_HPP_
 #define TRIGGERALGS_HORIZONTALMUON_TRIGGERCANDIDATEMAKERHORIZONTALMUON_HPP_
 
-#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/TriggerCandidateFactory.hpp"
 #include "triggeralgs/TAWindow.hpp"
 
 #include <fstream>

diff --git a/include/triggeralgs/MichelElectron/TriggerActivityMakerMichelElectron.hpp b/include/triggeralgs/MichelElectron/TriggerActivityMakerMichelElectron.hpp
@@ -9,7 +9,6 @@
 #ifndef TRIGGERALGS_MICHELELECTRON_TRIGGERACTIVITYMAKERMICHELELECTRON_HPP_
 #define TRIGGERALGS_MICHELELECTRON_TRIGGERACTIVITYMAKERMICHELELECTRON_HPP_
 
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 #include <fstream>
 #include <vector>

diff --git a/include/triggeralgs/MichelElectron/TriggerCandidateMakerMichelElectron.hpp b/include/triggeralgs/MichelElectron/TriggerCandidateMakerMichelElectron.hpp
@@ -9,7 +9,7 @@
 #ifndef TRIGGERALGS_MICHELELECTRON_TRIGGERCANDIDATEMAKERMICHELELECTRON_HPP_
 #define TRIGGERALGS_MICHELELECTRON_TRIGGERCANDIDATEMAKERMICHELELECTRON_HPP_
 
-#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/TriggerCandidateFactory.hpp"
 
 //#include "triggeralgs/triggercandidatemakerhorizontalmuon/Nljs.hpp"
 

diff --git a/include/triggeralgs/PlaneCoincidence/TriggerActivityMakerPlaneCoincidence.hpp b/include/triggeralgs/PlaneCoincidence/TriggerActivityMakerPlaneCoincidence.hpp
@@ -10,7 +10,6 @@
 #define TRIGGERALGS_PLANECOINCIDENCE_TRIGGERACTIVITYMAKERPLANECOINCIDENCE_HPP_
 
 #include "detchannelmaps/TPCChannelMap.hpp"
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 #include "triggeralgs/TPWindow.hpp"
 #include <fstream>

diff --git a/include/triggeralgs/PlaneCoincidence/TriggerCandidateMakerPlaneCoincidence.hpp b/include/triggeralgs/PlaneCoincidence/TriggerCandidateMakerPlaneCoincidence.hpp
@@ -9,7 +9,7 @@
 #ifndef TRIGGERALGS_PLANECOINCIDENCE_TRIGGERCANDIDATEMAKERPLANECOINCIDENCE_HPP_
 #define TRIGGERALGS_PLANECOINCIDENCE_TRIGGERCANDIDATEMAKERPLANECOINCIDENCE_HPP_
 
-#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/TriggerCandidateFactory.hpp"
 #include "triggeralgs/TAWindow.hpp"
 #include <fstream>
 #include <vector>

diff --git a/include/triggeralgs/Prescale/TriggerActivityMakerPrescale.hpp b/include/triggeralgs/Prescale/TriggerActivityMakerPrescale.hpp
@@ -9,7 +9,6 @@
 #ifndef TRIGGERALGS_PRESCALE_TRIGGERACTIVITYMAKERPRESCALE_HPP_
 #define TRIGGERALGS_PRESCALE_TRIGGERACTIVITYMAKERPRESCALE_HPP_
 
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 
 #include <vector>

diff --git a/include/triggeralgs/Prescale/TriggerCandidateMakerPrescale.hpp b/include/triggeralgs/Prescale/TriggerCandidateMakerPrescale.hpp
@@ -9,7 +9,7 @@
 #ifndef TRIGGERALGS_PRESCALE_TRIGGERCANDIDATEMAKERPRESCALE_HPP_
 #define TRIGGERALGS_PRESCALE_TRIGGERCANDIDATEMAKERPRESCALE_HPP_
 
-#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/TriggerCandidateFactory.hpp"
 
 #include <vector>
 

diff --git a/include/triggeralgs/Supernova/TriggerActivityMakerSupernova.hpp b/include/triggeralgs/Supernova/TriggerActivityMakerSupernova.hpp
@@ -9,7 +9,6 @@
 #ifndef TRIGGERALGS_SRC_TRIGGERALGS_SUPERNOVA_TRIGGERACTIVITYMAKERSUPERNOVA_HPP_
 #define TRIGGERALGS_SRC_TRIGGERALGS_SUPERNOVA_TRIGGERACTIVITYMAKERSUPERNOVA_HPP_
 
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 
 #include <algorithm>
@@ -52,8 +51,6 @@ class TriggerActivityMakerSupernova : public TriggerActivityMaker
 
   void flush(timestamp_t, std::vector<TriggerActivity>& tas) override { tas.push_back(MakeTriggerActivity()); }
 
-  static std::shared_ptr<TriggerActivityMaker> createMaker();
-
 protected:
   timestamp_diff_t m_time_tolerance =
     250; /// Maximum tolerated time difference between two primitives to form an activity (in 50 MHz clock ticks)

diff --git a/include/triggeralgs/Supernova/TriggerCandidateMakerSupernova.hpp b/include/triggeralgs/Supernova/TriggerCandidateMakerSupernova.hpp
@@ -9,7 +9,7 @@
 #ifndef TRIGGERALGS_SRC_TRIGGERALGS_SUPERNOVA_TRIGGERCANDIDATEMAKERSUPERNOVA_HPP_
 #define TRIGGERALGS_SRC_TRIGGERALGS_SUPERNOVA_TRIGGERCANDIDATEMAKERSUPERNOVA_HPP_
 
-#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/TriggerCandidateFactory.hpp"
 #include "triggeralgs/Types.hpp"
 
 #include <algorithm>

diff --git a/include/triggeralgs/TriggerActivityFactory.hpp b/include/triggeralgs/TriggerActivityFactory.hpp
@@ -9,41 +9,19 @@
 #define TRIGGERALGS_TRIGGER_ACTIVITY_FACTORY_HPP_
 
 #include "triggeralgs/TriggerActivityMaker.hpp"
-
-#include <memory>
-#include <string>
-#include <unordered_map>
-#include <functional>
+#include "triggeralgs/AbstractFactory.hpp"
 
 #define REGISTER_TRIGGER_ACTIVITY_MAKER(tam_name, tam_class)                                                                                      \
   static struct tam_class##Registrar {                                                                                                            \
     tam_class##Registrar() {                                                                                                                      \
-      TriggerActivityFactory::registerCreator(tam_name, []() -> std::shared_ptr<TriggerActivityMaker> {return std::make_shared<tam_class>();});   \
+      TriggerActivityFactory::register_creator(tam_name, []() -> std::unique_ptr<TriggerActivityMaker> {return std::make_unique<tam_class>();});   \
     }                                                                                                                                             \
   } tam_class##_registrar;
 
 namespace triggeralgs {
 
-class TriggerActivityFactory
-{
-  public:
-    using TAMakerCreator = std::function<std::shared_ptr<TriggerActivityMaker>()>;
-    using TAMakerMap = std::unordered_map<std::string, TAMakerCreator>;
-
-  public:
-    TriggerActivityFactory(const TriggerActivityFactory&) = delete;
-    TriggerActivityFactory& operator=(const TriggerActivityFactory&) = delete;
-    virtual ~TriggerActivityFactory() {}
-
-    static std::shared_ptr<TriggerActivityMaker> makeTAMaker(const std::string& algName);
-
-    static void registerCreator(const std::string algName, TAMakerCreator creator);
-
-  private:
-    static TAMakerMap& getTAMakers();
-};
+class TriggerActivityFactory : public AbstractFactory<TriggerActivityMaker> {};
 
 } /* namespace triggeralgs */
 
-// TODO: Define ers exceptions
 #endif // TRIGGERALGS_TRIGGER_ACTIVITY_FACTORY_HPP_
diff --git a/include/triggeralgs/TriggerCandidateFactory.hpp b/include/triggeralgs/TriggerCandidateFactory.hpp
@@ -0,0 +1,27 @@
+/* @file: TriggerCandidateFactory.hpp
+ *
+ * This is part of the DUNE DAQ Application Framework, copyright 2023.
+ * Licensing/copyright details are in the COPYING file that you should have
+ * received with this code.
+ */
+
+#ifndef TRIGGERALGS_TRIGGER_CANDIDATE_FACTORY_HPP_
+#define TRIGGERALGS_TRIGGER_CANDIDATE_FACTORY_HPP_
+
+#include "triggeralgs/TriggerCandidateMaker.hpp"
+#include "triggeralgs/AbstractFactory.hpp"
+
+#define REGISTER_TRIGGER_CANDIDATE_MAKER(tcm_name, tcm_class)                                                                                      \
+  static struct tcm_class##Registrar {                                                                                                            \
+    tcm_class##Registrar() {                                                                                                                      \
+      TriggerCandidateFactory::register_creator(tcm_name, []() -> std::unique_ptr<TriggerCandidateMaker> {return std::make_unique<tcm_class>();});   \
+    }                                                                                                                                             \
+  } tcm_class##_registrar;
+
+namespace triggeralgs {
+
+class TriggerCandidateFactory : public AbstractFactory<TriggerCandidateMaker> {};
+
+} /* namespace triggeralgs */
+
+#endif // TRIGGERALGS_TRIGGER_CANDIDATE_FACTORY_HPP_
diff --git a/include/triggeralgs/dbscan/TriggerActivityMakerDBSCAN.hpp b/include/triggeralgs/dbscan/TriggerActivityMakerDBSCAN.hpp
@@ -9,7 +9,6 @@
 #ifndef TRIGGERALGS_DBSCAN_TRIGGERACTIVITYMAKERDBSCAN_HPP_
 #define TRIGGERALGS_DBSCAN_TRIGGERACTIVITYMAKERDBSCAN_HPP_
 
-#include "triggeralgs/TriggerActivityMaker.hpp"
 #include "triggeralgs/TriggerActivityFactory.hpp"
 #include "triggeralgs/dbscan/dbscan.hpp"
 

diff --git a/src/TriggerActivityFactory.cpp b/src/TriggerActivityFactory.cpp
diff --git a/src/TriggerCandidateMakerADCSimpleWindow.cpp b/src/TriggerCandidateMakerADCSimpleWindow.cpp
@@ -9,7 +9,7 @@
 #include "triggeralgs/ADCSimpleWindow/TriggerCandidateMakerADCSimpleWindow.hpp"
 
 #include "TRACE/trace.h"
-#define TRACE_NAME "TriggerCandidateMakerADCSimpleWindow"
+#define TRACE_NAME "TriggerCandidateMakerADCSimpleWindowPlugin"
 
 #include <vector>
 
@@ -44,3 +44,4 @@ TriggerCandidateMakerADCSimpleWindow::configure(const nlohmann::json &config)
 {
 }
 
+REGISTER_TRIGGER_CANDIDATE_MAKER(TRACE_NAME, TriggerCandidateMakerADCSimpleWindow)
diff --git a/src/TriggerCandidateMakerHorizontalMuon.cpp b/src/TriggerCandidateMakerHorizontalMuon.cpp
@@ -9,7 +9,7 @@
 #include "triggeralgs/HorizontalMuon/TriggerCandidateMakerHorizontalMuon.hpp"
 
 #include "TRACE/trace.h"
-#define TRACE_NAME "TriggerCandidateMakerHorizontalMuon"
+#define TRACE_NAME "TriggerCandidateMakerHorizontalMuonPlugin"
 
 #include <vector>
 #include <math.h>
@@ -227,3 +227,5 @@ reset."; m_current_window.clear();
 
   return;
 }*/
+
+REGISTER_TRIGGER_CANDIDATE_MAKER(TRACE_NAME, TriggerCandidateMakerHorizontalMuon)
diff --git a/src/TriggerCandidateMakerMichelElectron.cpp b/src/TriggerCandidateMakerMichelElectron.cpp
@@ -9,7 +9,7 @@
 #include "triggeralgs/MichelElectron/TriggerCandidateMakerMichelElectron.hpp"
 
 #include "TRACE/trace.h"
-#define TRACE_NAME "TriggerCandidateMakerMichelElectron"
+#define TRACE_NAME "TriggerCandidateMakerMichelElectronPlugin"
 
 #include <vector>
 
@@ -219,3 +219,5 @@ reset."; m_current_window.clear();
 
   return;
 }*/
+
+REGISTER_TRIGGER_CANDIDATE_MAKER(TRACE_NAME, TriggerCandidateMakerMichelElectron)