HDF5FileLayout.hpp

Go to the documentation of this file.

 
#ifndef HDF5LIBS_INCLUDE_HDF5LIBS_HDF5FILELAYOUT_HPP_
#define HDF5LIBS_INCLUDE_HDF5LIBS_HDF5FILELAYOUT_HPP_
 
#include "hdf5libs/HDF5FileLayoutParameters.hpp"
 
#include "daqdataformats/Fragment.hpp"
#include "daqdataformats/SourceID.hpp"
#include "daqdataformats/TimeSliceHeader.hpp"
#include "daqdataformats/TriggerRecordHeader.hpp"
#include "logging/Logging.hpp" // NOTE: if ISSUES ARE DECLARED BEFORE include logging/Logging.hpp, TLOG_DEBUG<<issue wont work.
 
#include "nlohmann/json.hpp"
 
#include <cstdint>
#include <iomanip>
#include <limits>
#include <map>
#include <memory>
#include <sstream>
#include <string>
#include <vector>
 
namespace dunedaq {
 
ERS_DECLARE_ISSUE(hdf5libs, InvalidRecordName, "Record name " << name << " is unknown.", ((std::string)name))
 
ERS_DECLARE_ISSUE(hdf5libs,
                  InvalidSequenceDigits,
                  "Record name of type " << name << " must have sequence digits" << digits << ". Resetting that now.",
                  ((std::string)name)((int32_t)digits))
 
ERS_DECLARE_ISSUE(hdf5libs,
                  FileLayoutSequenceIDsCannotBeZero,
                  "Cannot specify 0 digits for sequence IDs in TriggerRecords. Reverting to " << digits,
                  ((uint64_t)digits)) // NOLINT(build/unsigned)
 
ERS_DECLARE_ISSUE(hdf5libs,
                  FileLayoutNotEnoughDigitsForPath,
                  "Number " << number << " has more digits than the max specified of " << digits
                            << ". Using natural width.",
                  ((uint64_t)number)((uint64_t)digits)) // NOLINT(build/unsigned)
 
ERS_DECLARE_ISSUE(hdf5libs,
                  FileLayoutInvalidSubsystem,
                  "Bad File Layout cofiguration: subsystem name " << subsys_name << " is invalid.",
                  ((std::string)subsys_name))
 
ERS_DECLARE_ISSUE(hdf5libs,
                  FileLayoutUnconfiguredSubsystem,
                  "Requested File Layout for unconfigured subsystem type " << subsys_type << " (" << subsys_name << ")",
                  ((daqdataformats::SourceID::Subsystem)subsys_type)((std::string)subsys_name))
 
namespace hdf5libs {
 
class HDF5FileLayout
{
public:
  explicit HDF5FileLayout(HDF5FileLayoutParameters conf, uint32_t version = 7); // NOLINT(build/unsigned)
 
  uint32_t get_version() const noexcept // NOLINT(build/unsigned)
  {
    return m_version;
  }
 
  std::string get_record_name_prefix() const noexcept { return m_conf_params.record_name_prefix; }
 
  int get_digits_for_record_number() const noexcept { return m_conf_params.digits_for_record_number; }
 
  int get_digits_for_sequence_number() const noexcept { return m_conf_params.digits_for_sequence_number; }
 
  std::string get_record_header_dataset_name() const noexcept { return m_conf_params.record_header_dataset_name; }
 
  std::map<daqdataformats::SourceID::Subsystem, HDF5PathParameters> get_path_params_map() const
  {
    return m_path_params_map;
  }
 
  HDF5PathParameters get_path_params(daqdataformats::SourceID::Subsystem type) const;
 
  HDF5FileLayoutParameters get_file_layout_params() const { return m_conf_params; }
 
  std::string get_record_number_string(uint64_t record_number, // NOLINT(build/unsigned)
                                       daqdataformats::sequence_number_t seq_num = 0) const;
 
  std::string get_trigger_number_string(daqdataformats::trigger_number_t trig_num,
                                        daqdataformats::sequence_number_t seq_num = 0) const;
 
  std::string get_timeslice_number_string(daqdataformats::timeslice_number_t ts_num) const;
 
  std::vector<std::string> get_path_elements(const daqdataformats::TriggerRecordHeader& trh) const;
 
  std::vector<std::string> get_path_elements(const daqdataformats::TimeSliceHeader& tsh) const;
 
  std::vector<std::string> get_path_elements(const daqdataformats::FragmentHeader& fh) const;
 
  std::string get_path_string(const daqdataformats::TimeSliceHeader& tsh) const;
 
  daqdataformats::SourceID get_source_id_from_path_elements(std::vector<std::string> const& path_elements) const;
 
  std::string get_record_header_path(uint64_t rec_num, // NOLINT (build/unsigned)
                                     daqdataformats::sequence_number_t seq_num = 0) const;
 
  std::string get_trigger_record_header_path(daqdataformats::trigger_number_t trig_num,
                                             daqdataformats::sequence_number_t seq_num = 0) const;
 
  std::string get_timeslice_header_path(daqdataformats::timeslice_number_t ts_num) const;
 
  std::string get_fragment_path(uint64_t trig_num, // NOLINT(build/unsigned)
                                daqdataformats::sequence_number_t seq_num,
                                daqdataformats::SourceID element_id) const;
  std::string get_fragment_path(uint64_t trig_num, // NOLINT(build/unsigned)
                                daqdataformats::sequence_number_t seq_num,
                                daqdataformats::SourceID::Subsystem type,
                                uint32_t element_id) const; // NOLINT(build/unsigned)
 
  std::string get_fragment_path(uint64_t trig_num, // NOLINT(build/unsigned)
                                daqdataformats::sequence_number_t seq_num,
                                const std::string& typestring,
                                uint32_t element_id) const; // NOLINT(build/unsigned)
 
  std::string get_fragment_type_path(uint64_t trig_num, // NOLINT(build/unsigned)
                                     daqdataformats::sequence_number_t seq_num,
                                     daqdataformats::SourceID::Subsystem type) const;
 
  std::string get_fragment_type_path(uint64_t trig_num, // NOLINT(build/unsigned)
                                     daqdataformats::sequence_number_t seq_num,
                                     std::string typestring) const;
 
private:
  HDF5FileLayoutParameters m_conf_params;
 
  uint32_t m_version; // NOLINT(build/unsigned)
 
  std::map<daqdataformats::SourceID::Subsystem, HDF5PathParameters> m_path_params_map;
 
  std::map<std::string, daqdataformats::SourceID::Subsystem> m_detector_group_name_to_type_map;
 
  void fill_path_params_maps(HDF5FileLayoutParameters const& flp);
 
  HDF5FileLayoutParameters get_v0_file_layout_params();
 
  void check_config();
};
 
} // namespace hdf5libs
} // namespace dunedaq
 
#endif // HDF5LIBS_INCLUDE_HDF5LIBS_HDF5FILELAYOUT_HPP_