CbmRunDatabase.h

Go to the documentation of this file.

/* Copyright (C) 2025 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergei Zharko [committer] */

 
// DISCLAIMER
//
// Logic of this class is not final and will be (hopefully) improved.
 
// FIXME: optimize parameter storage for setup geo tag (struct SetupConfig??)
 
#ifndef CbmRunDatabase_h
#define CbmRunDatabase_h 1
 
#include "CbmYaml.h"
 
#include <map>
#include <string>
 
namespace cbm
{
  class RunDatabase {
    struct DbCommon {
      std::map<uint32_t, std::string> geoSetup;  
      // NOTE: std::map is used, because the keys must be ordered
 
      CBM_YAML_PROPERTIES(
        util::yaml::Property(&RunDatabase::DbCommon::geoSetup,  "geoSetup", "Run ID map for geometry setup tags"));
    };

    struct DbCalibration {
      std::map<uint32_t, std::string> bmon;  
      std::map<uint32_t, std::string> tof;   
      // NOTE: std::map is used, because the keys must be ordered
 
      CBM_YAML_PROPERTIES(
        util::yaml::Property(&RunDatabase::DbCalibration::bmon, "bmon", "Run ID map for BMON calibration tags"),
        util::yaml::Property(&RunDatabase::DbCalibration::tof,  "tof", "Run ID map for TOF calibration tags"));
    };

    struct DbContents {
      DbCommon common;                            
      DbCalibration calibration;                  
      std::map<uint32_t, std::string> alignment;  
      std::map<uint32_t, std::string> recoPar;    
      // NOTE: std::map is used, because the keys must be ordered
 
      CBM_YAML_PROPERTIES(
        util::yaml::Property(&RunDatabase::DbContents::common, "common", "Common parameters"),
        util::yaml::Property(&RunDatabase::DbContents::calibration, "calibration", "Calibration of detector subsystems"),
        util::yaml::Property(&RunDatabase::DbContents::alignment, "alignment", "Alignment matrices tag"),
        util::yaml::Property(&RunDatabase::DbContents::recoPar, "recoPar", "Reconstruction parameter tag"));
    };

    struct DbStartTimeMcbm {
      std::unordered_map<uint32_t, uint64_t> runStartTime;  
 
      CBM_YAML_PROPERTIES(
        algo::yaml::Property(&RunDatabase::DbStartTimeMcbm::runStartTime,  "run_start", "Run ID map to start time"));
    };
 
   public:
    const std::string& GetBmonCalibrationTag() const { return fBmonCalibrationTag; }

    const std::string& GetGeoSetupTag() const { return fGeoSetupTag; }

    const std::string& GetTofCalibrationTag() const { return fTofCalibrationTag; }

    const std::string& GetAlignmentTag() const { return fAlignmentTag; }

    const std::string& GetRecoParTag() const { return fRecoParTag; }

    std::string GetRecoParDir() const { return std::string("parameters/online/recoPar/") + fRecoParTag; }

    uint64_t GetRunStartTime() const { return fRunStartTimeNs / 1000000000; }

    const uint64_t& GetRunStartTimeNs() const { return fRunStartTimeNs; }

    std::string GetAlgoMainConfigPath() const { return GetRecoParDir() + "/MainConfig.yaml"; }

    uint32_t GetRunId() const { return fRunId; }

    bool LoadRun(uint32_t runId);

    void SetPathCommonDb(const std::string& pathCommonDb) { fPathCommonDb = pathCommonDb; }

    void SetPathRunStartTimeDb(const std::string& pathRunStartTimeDb) { fPathRunStartTimeDb = pathRunStartTimeDb; }

    std::string ToString() const;
 
   private:
    //* Database properties
    std::string fPathCommonDb;        
    std::string fPathRunStartTimeDb;  
 
    //* Run properties
    std::string fBmonCalibrationTag;  
    std::string fTofCalibrationTag;   
    std::string fGeoSetupTag;         
    std::string fAlignmentTag;        
    std::string fRecoParTag;          
    uint64_t fRunStartTimeNs;         
    uint32_t fRunId{0};               
  };
}  // namespace cbm
 
#endif  // CbmRunDatabase_h