making inputdata a global instance

Author: martinunland

common/framework/include/OMSim.hh

@@ -3,7 +3,7 @@
  * @brief Main simulation class for the Optical Module (OM) simulation.
  * This file defines the OMSim class, which controls the entire simulation process in all studies and includes the general program options.
  * @warning
- * There are a few material related arguments that are depracated as for example the glass and gel arguments. This were used to easily change materials during the OM development phase. Check @link InputDataManager::getMaterial @endlink and modify the respective OM class if you want to use these args.
+ * There are a few material related arguments that are depracated as for example the glass and gel arguments. This were used to easily change materials during the OM development phase. Check @link OMSimInputData::getMaterial @endlink and modify the respective OM class if you want to use these args.
  * @ingroup common
  */
 

common/framework/include/OMSimCommandArgsTable.hh

@@ -31,12 +31,20 @@
 #include <boost/any.hpp>
 #include <sys/time.h>
 
+
+// Forward declaration of the class
+class OMSimCommandArgsTable;
+
+// Declaration and definition of the inline global pointer
+inline OMSimCommandArgsTable* gCommandArgsTable = nullptr;
+
+
 /**
  * @class OMSimCommandArgsTable
- * @brief A singleton class used to hold OMSim command arguments.
+ * @brief A class used to hold OMSim command arguments with global instance access.
  *
- * This class uses a map to hold key-value pairs of simulation command arguments. In principle it is just a wrapper around the map created by the boost library to avoid users changing the arg values after initialisation.
- * Provides a method to write the parameters to a JSON file.
+ * This class uses a map to hold key-value pairs of simulation command arguments.
+ * It provides a method to write the parameters to a JSON file.
  * @ingroup common
  */
 class OMSimCommandArgsTable
@@ -50,14 +58,27 @@ public:
     using Key = std::string;
     using Value = boost::any; //  Using boost::any to hold any type
 
+    static void init()
+    {
+        if (!gCommandArgsTable)
+            gCommandArgsTable = new OMSimCommandArgsTable();
+    }
+
+    static void shutdown()
+    {
+        delete gCommandArgsTable;
+        gCommandArgsTable = nullptr;
+    }
+
     /**
-     * @brief Retrieves the instance of the singleton.
-     * @return The instance of OMSimCommandArgsTable.
+     * @return A reference to the OMSimCommandArgsTable instance.
+     * @throw std::runtime_error if accessed before initialization or after shutdown.
      */
     static OMSimCommandArgsTable &getInstance()
     {
-        static OMSimCommandArgsTable instance;
-        return instance;
+        if (!gCommandArgsTable)
+            throw std::runtime_error("OMSimCommandArgsTable accessed before initialization or after shutdown!");
+        return *gCommandArgsTable;
     }
 
     /**

common/framework/include/OMSimInputData.hh

@@ -1,5 +1,5 @@
 /** @file
- *  @brief Definition of ParameterTable and InputDataManager.
+ *  @brief Definition of ParameterTable and OMSimInputData.
  * @ingroup common
  */
 
@@ -20,7 +20,7 @@ namespace pt = boost::property_tree;
  * Interface for handling and querying data in the form of a property tree of the boost library. It facilitates the extraction of specific
  * parameters from loaded JSON files while also supporting units and scales.
  * 
- * Its main use is as base class of InputDataManager, but you may use it as needed (see @ref ExampleUsageParameterTable).
+ * Its main use is as base class of OMSimInputData, but you may use it as needed (see @ref ExampleUsageParameterTable).
  *
  * @ingroup common
  *
@@ -165,7 +165,7 @@ private:
 };
 
 /**
- * @class InputDataManager
+ * @class OMSimInputData
  * @brief Manages the input data, including parsing and storing material properties.
  *
  * @details
@@ -178,7 +178,7 @@ private:
  * Example usage (see also @ref ExampleUsageParameterTable):
  *
  * @code
- * InputDataManager lManager;
+ * OMSimInputData lManager;
  * lManager.searchFolders(); // Search for all recognized data files in the predefined directories
  * G4Material* lWater = manager.getMaterial("CustomWater"); // Retrieve a Geant4 material by name
  * G4OpticalSurface* lSurface = manager.getOpticalSurface("SomeSurfaceName"); // Retrieve an optical surface by name
@@ -190,21 +190,28 @@ private:
  *
  * @ingroup common
  */
-class InputDataManager : public ParameterTable
+class OMSimInputData : public ParameterTable
 {
 public:
-    InputDataManager(){};
-    ~InputDataManager(){};
+    static void init();
+    static void shutdown();
+    static OMSimInputData& getInstance();
     G4Material *getMaterial(G4String pName);
     G4OpticalSurface *getOpticalSurface(G4String pName);
     void searchFolders();
     std::map<G4String, G4OpticalSurface *> mOpticalSurfaceMap; ///< Map that links names with optical surfaces.
 
 private:
+    OMSimInputData() = default;
+    ~OMSimInputData() = default;
+    OMSimInputData(const OMSimInputData&) = delete;
+    OMSimInputData& operator=(const OMSimInputData&) = delete;
     void scannDataDirectory();
     void processFile(const std::string &filePath, const std::string &fileName);
     G4String mDataDirectory; ///< The current directory being scanned for data.
 };
 
+inline OMSimInputData* gOMSimInputData = nullptr;
+
 #endif
 //

common/framework/src/OMSim.cc

@@ -3,7 +3,7 @@
  * @brief Implementation of the OMSim class.
  * 
  * @warning
- * There are a few material related arguments that are depracated as for example the glass and gel arguments. This were used to easily change materials during the OM development phase. Check @link InputDataManager::getMaterial @endlink and modify the respective OM class if you want to use these args.
+ * There are a few material related arguments that are depracated as for example the glass and gel arguments. This were used to easily change materials during the OM development phase. Check @link OMSimInputData::getMaterial @endlink and modify the respective OM class if you want to use these args.
  * 
  * @ingroup common
  */
@@ -23,6 +23,7 @@ mRunManager(nullptr),
 mVisManager(nullptr),
 mNavigator(nullptr)
 {
+    OMSimCommandArgsTable::init();
     setGeneralOptions();
     initialLoggerConfiguration();
 }
@@ -145,9 +146,9 @@ int OMSim::determineNumberOfThreads()
  */
 void OMSim::initialiseSimulation(OMSimDetectorConstruction* pDetectorConstruction)
 {
-    configureLogger();
     OMSimHitManager::init();
-
+    configureLogger();
+    
     OMSimCommandArgsTable &lArgs = OMSimCommandArgsTable::getInstance();
     ensureOutputDirectoryExists(lArgs.get<std::string>("output_file"));
 
@@ -280,6 +281,8 @@ OMSim::~OMSim()
     log_trace("Deleting OMSimHitManager");
     OMSimHitManager::shutdown();
 
+    log_trace("Deleting OMSimCommandArgsTable");
+    OMSimCommandArgsTable::shutdown();
 
     log_trace("OMSim destructor finished");
     std::chrono::high_resolution_clock::time_point lFinishtime = std::chrono::high_resolution_clock::now();

common/framework/src/OMSimInputData.cc

@@ -116,6 +116,34 @@ G4bool ParameterTable::checkIfKeyInTable(G4String pKey)
  * %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  */
 
+
+void OMSimInputData::init()
+{
+    if (!gOMSimInputData){
+        gOMSimInputData = new OMSimInputData();
+        gOMSimInputData->searchFolders();
+    }
+        
+}
+
+void OMSimInputData::shutdown()
+{
+    delete gOMSimInputData;
+    gOMSimInputData = nullptr;
+}
+
+/**
+ * @return A reference to the OMSimInputData instance.
+ * @throw std::runtime_error if accessed before initialization or after shutdown.
+ */
+OMSimInputData& OMSimInputData::getInstance()
+{
+    if (!gOMSimInputData)
+        throw std::runtime_error("OMSimInputData accessed before initialization or after shutdown!");
+    return *gOMSimInputData;
+}
+
+
 /**
  * Get a G4Material. In order to get custom built materials, method
  * searchFolders() should have already been called. Standard materials from
@@ -127,7 +155,7 @@ G4bool ParameterTable::checkIfKeyInTable(G4String pKey)
  * "argWorld" for argument materials
  * @return G4Material
  */
-G4Material *InputDataManager::getMaterial(G4String pName)
+G4Material *OMSimInputData::getMaterial(G4String pName)
 {
 
     // Check if requested material is an argument material
@@ -173,7 +201,7 @@ G4Material *InputDataManager::getMaterial(G4String pName)
  * "argReflector"
  * @return G4OpticalSurface
  */
-G4OpticalSurface *InputDataManager::getOpticalSurface(G4String pName)
+G4OpticalSurface *OMSimInputData::getOpticalSurface(G4String pName)
 {
 
     // Check if requested material is an argument surface
@@ -204,7 +232,7 @@ G4OpticalSurface *InputDataManager::getOpticalSurface(G4String pName)
 /**
  * @brief Searches through predefined folders for input data files.
  */
-void InputDataManager::searchFolders()
+void OMSimInputData::searchFolders()
 {
     log_trace("Searching folders for data json files...");
     std::vector<std::string> directories = {
@@ -233,7 +261,7 @@ void InputDataManager::searchFolders()
  * @param pFilePath Full path to the file.
  * @param pFileName Name of the file (without the path).
  */
-void InputDataManager::processFile(const std::string &pFilePath,
+void OMSimInputData::processFile(const std::string &pFilePath,
                                    const std::string &pFileName)
 {
     log_trace("Processing file {}", pFileName);
@@ -284,7 +312,7 @@ void InputDataManager::processFile(const std::string &pFilePath,
  * Scann for data files inside mDataDirectory and process files.
  * @param pName name of the material
  */
-void InputDataManager::scannDataDirectory()
+void OMSimInputData::scannDataDirectory()
 {
     log_trace("Loading files in {}", mDataDirectory);
     DIR *lDirectory = opendir(mDataDirectory.data());

common/geometry_construction/include/OMSimDEGG.hh

@@ -23,7 +23,7 @@ class DEggHarness;
 class DEGG : public OMSimOpticalModule
 {
 public:
-    DEGG(InputDataManager *pData, G4bool pPlaceHarness = true);
+    DEGG(G4bool pPlaceHarness = true);
     ~DEGG(){};
 
     void construction();

common/geometry_construction/include/OMSimDEGGHarness.hh

@@ -13,8 +13,7 @@ class DEGG;
 class DEggHarness : public abcDetectorComponent
 {
 public:
-    // DEggHarness(InputDataManager *pData);
-    DEggHarness(DEGG *pDEGG, InputDataManager *pData);
+    DEggHarness(DEGG *pDEGG);
     void construction();
     G4String mDataKey = "om_DEGG_Harness";
 

common/geometry_construction/include/OMSimDetectorConstruction.hh

@@ -27,14 +27,14 @@ public:
     void ConstructSDandField() override;
     void registerSensitiveDetector(G4LogicalVolume* logVol, G4VSensitiveDetector* aSD);
     G4VPhysicalVolume *mWorldPhysical;
-    InputDataManager* getDataManager() {return mData;};
+    OMSimInputData* getDataManager() {return mData;};
 
 protected:
     G4VSolid *mWorldSolid;
     G4LogicalVolume *mWorldLogical;
     virtual void constructWorld() = 0;
     virtual void constructDetector() = 0;
-    InputDataManager *mData;
+    OMSimInputData *mData;
 
     struct SDInfo {
         G4LogicalVolume* logicalVolume;

common/geometry_construction/include/OMSimLOM16.hh

@@ -12,7 +12,7 @@
 class LOM16 : public OMSimOpticalModule
 {
 public:
-    LOM16(InputDataManager* pData, G4bool pPlaceHarness = false);
+    LOM16(G4bool pPlaceHarness = false);
     ~LOM16();
     void construction();
     double getPressureVesselWeight() {return (5.38+5.35)*kg;};

common/geometry_construction/include/OMSimLOM18.hh

@@ -14,7 +14,7 @@
 class LOM18 : public OMSimOpticalModule
 {
 public:
-    LOM18(InputDataManager* pData, G4bool pPlaceHarness = false);
+    LOM18(G4bool pPlaceHarness = false);
     ~LOM18();
     void construction();
     double getPressureVesselWeight() {return 17.0*kg;};