eCAL::hdf5 / eCAL::measurement_hdf5 Refactoring (#1235)

* Minor refactoring to keep eCAL::hdf5 like it was before measurement restructuring.
* move eh5_reader / eh5_writer to new namespace
(#1076)

CMakeLists.txt

@@ -369,6 +369,7 @@ endif()
 # ecal hdf5 support
 # --------------------------------------------------------
 if(HAS_HDF5)
+  add_subdirectory(contrib/measurement/hdf5)
   add_subdirectory(contrib/ecalhdf5)
   add_subdirectory(contrib/message)
 endif()

app/meas_cutter/CMakeLists.txt

@@ -52,7 +52,7 @@ target_include_directories(${PROJECT_NAME}
 target_link_libraries(${PROJECT_NAME}   yaml-cpp
                                         tclap::tclap
                                         eCAL::ecal-utils
-                                        eCAL::hdf5
+                                        eCAL::measurement_hdf5
                                         Threads::Threads)
 
 target_compile_features(${PROJECT_NAME} PRIVATE cxx_std_14) 

app/meas_cutter/src/measurement_exporter.cpp

@@ -18,10 +18,10 @@
 */
 
 #include "measurement_exporter.h"
-#include <ecalhdf5/eh5_writer.h>
+#include <ecal/measurement/hdf5/writer.h>
 
 MeasurementExporter::MeasurementExporter():
-  _writer(std::make_unique<eCAL::eh5::Writer>())
+  _writer(std::make_unique<eCAL::measurement::hdf5::Writer>())
 {
 }
 

app/meas_cutter/src/measurement_importer.cpp

@@ -18,10 +18,10 @@
 */
 
 #include "measurement_importer.h"
-#include <ecalhdf5/eh5_reader.h>
+#include <ecal/measurement/hdf5/reader.h>
 
 MeasurementImporter::MeasurementImporter() :
-  _reader(std::make_unique<eCAL::eh5::Reader>()),
+  _reader(std::make_unique<eCAL::measurement::hdf5::Reader>()),
   _current_opened_channel_data()
 {
 }

app/meas_cutter/src/utils.h

@@ -29,12 +29,13 @@
 #define YAML_CPP_STATIC_DEFINE
 #include "yaml-cpp/yaml.h"
 
-#include <ecalhdf5/eh5_meas.h>
 #include <ecal_utils/str_convert.h>
 #include <ecal_utils/filesystem.h>
 
 #include "logger.h"
 
+#include <ecal/measurement/base/types.h>
+
 namespace eCALMeasCutterUtils
 {
   typedef long long Timestamp;

app/play/play_core/CMakeLists.txt

@@ -58,7 +58,7 @@ target_link_libraries(${PROJECT_NAME} PUBLIC
   eCAL::core
   eCAL::app_pb
   eCAL::ecaltime_pb
-  eCAL::hdf5
+  eCAL::measurement_hdf5
 )
 
 target_link_libraries(${PROJECT_NAME} PRIVATE

app/play/play_core/src/ecal_play.cpp

@@ -27,7 +27,7 @@
 
 #include "ecal_play_logger.h"
 #include "play_thread.h"
-#include "ecalhdf5/eh5_reader.h"
+#include <ecal/measurement/hdf5/reader.h>
 
 #include <ecal_utils/string.h>
 #include <ecal_utils/filesystem.h>
@@ -58,7 +58,7 @@ bool EcalPlay::LoadMeasurement(const std::string& path)
 {
   EcalPlayLogger::Instance()->info("Loading measurement...");
 
-  std::shared_ptr<eCAL::measurement::base::Reader> measurement(std::make_shared<eCAL::eh5::Reader>());
+  std::shared_ptr<eCAL::measurement::base::Reader> measurement(std::make_shared<eCAL::measurement::hdf5::Reader>());
 
   std::string meas_dir;               // The directory of the measurement
   std::string path_to_load;           // The actual path we load the measurement from. May be a directory or a .hdf5 file

app/play/play_core/src/measurement_container.cpp

@@ -18,7 +18,7 @@
 */
 
 #include "measurement_container.h"
-#include <ecalhdf5/eh5_meas.h>
+#include <ecal/measurement/hdf5/reader.h>
 
 #include <algorithm>
 #include <math.h>

app/play/play_core/src/play_thread.h

@@ -27,7 +27,6 @@
 #include "ecal_play_command.h"
 #include "stop_watch.h"
 
-#include <ecalhdf5/eh5_meas.h>
 #include <ecal/ecal.h>
 
 #include <memory>

app/rec/rec_client_core/CMakeLists.txt

@@ -98,7 +98,7 @@ target_link_libraries(${PROJECT_NAME}
     eCAL::core_pb
     eCAL::app_pb
   PRIVATE
-    eCAL::hdf5
+    eCAL::measurement_hdf5
     ThreadingUtils
     Threads::Threads
     eCAL::ecal-utils

app/rec/rec_client_core/src/job/hdf5_writer_thread.cpp

@@ -18,7 +18,7 @@
 */
 
 #include "hdf5_writer_thread.h"
-#include <ecalhdf5/eh5_writer.h>
+#include <ecal/measurement/hdf5/writer.h>
 
 #include "rec_client_core/ecal_rec_logger.h"
 
@@ -42,7 +42,7 @@ namespace eCAL
       , new_topic_info_map_available_(true)
       , flushing_                    (false)
     {
-      hdf5_writer_ = std::make_unique<eCAL::eh5::Writer>();
+      hdf5_writer_ = std::make_unique<eCAL::measurement::hdf5::Writer>();
     }
 
     Hdf5WriterThread::~Hdf5WriterThread()

contrib/ecalhdf5/CMakeLists.txt

@@ -50,14 +50,9 @@ set(ecalhdf5_src
 )
 
 set(ecalhdf5_header_base
-    include/ecal/measurement/imeasurement.h
-    include/ecal/measurement/measurement.h
-    include/ecal/measurement/omeasurement.h
     include/ecalhdf5/eh5_defs.h
     include/ecalhdf5/eh5_meas.h
-    include/ecalhdf5/eh5_reader.h
     include/ecalhdf5/eh5_types.h
-    include/ecalhdf5/eh5_writer.h
 )
 
 ecal_add_library(${PROJECT_NAME} ${ecalhdf5_src} ${ecalhdf5_header_base})
@@ -79,8 +74,8 @@ target_compile_options(${PROJECT_NAME}
     $<$<CXX_COMPILER_ID:GNU>:-Wextra>)
 
 target_link_libraries(${PROJECT_NAME} 
-  PUBLIC 
-    eCAL::message
+  PUBLIC
+    eCAL::measurement_base
   PRIVATE  
     eCAL::ecal-utils
 )

contrib/ecalhdf5/include/ecalhdf5/eh5_meas.h

@@ -30,7 +30,6 @@
 #include <memory>
 
 #include "eh5_types.h"
-#include <ecal/measurement/base/measurement.h>
 
 namespace eCAL
 {
@@ -41,7 +40,7 @@ namespace eCAL
     /**
      * @brief eCAL HDF5 measurement API
     **/
-    class HDF5Meas : public eCAL::measurement::base::Measurement
+    class HDF5Meas
     {
     public:
       /**
@@ -61,7 +60,7 @@ namespace eCAL
       /**
        * @brief Destructor
       **/
-      ~HDF5Meas() override;
+      ~HDF5Meas();
 
       /**
        * @brief Copy constructor deleted
@@ -106,42 +105,42 @@ namespace eCAL
        * @return         true if output (eAccessType::CREATE) measurement directory structure can be accessed/created, false otherwise.
        *                 true if input (eAccessType::RDONLY) measurement/file path was opened, false otherwise.
       **/
-      bool Open(const std::string& path, measurement::base::AccessType access = measurement::base::AccessType::RDONLY) override;
+      bool Open(const std::string& path, measurement::base::AccessType access = measurement::base::AccessType::RDONLY);
 
       /**
        * @brief Close file
        *
        * @return         true if succeeds, false if it fails
       **/
-      bool Close() override;
+      bool Close();
 
       /**
        * @brief Checks if file/measurement is ok
        *
        * @return  true if meas can be opened(read) or location is accessible(write), false otherwise
       **/
-      bool IsOk() const override;
+      bool IsOk() const;
 
       /**
        * @brief Get the File Type Version of the current opened file
        *
        * @return       file version
       **/
-      std::string GetFileVersion() const override;
+      std::string GetFileVersion() const;
 
       /**
        * @brief Gets maximum allowed size for an individual file
        *
        * @return       maximum size in MB
       **/
-      size_t GetMaxSizePerFile() const override;
+      size_t GetMaxSizePerFile() const;
 
       /**
        * @brief Sets maximum allowed size for an individual file
        *
        * @param size   maximum size in MB
       **/
-      void SetMaxSizePerFile(size_t size) override;
+      void SetMaxSizePerFile(size_t size);
 
       /**
       * @brief Whether each Channel shall be writte in its own file
@@ -152,7 +151,7 @@ namespace eCAL
       * 
       * @return true, if one file per channel is enabled
       */
-      bool IsOneFilePerChannelEnabled() const override;
+      bool IsOneFilePerChannelEnabled() const;
 
       /**
       * @brief Enable / disable the creation of one individual file per channel
@@ -163,14 +162,14 @@ namespace eCAL
       * 
       * @param enabled   Whether one file shall be created per channel
       */
-      void SetOneFilePerChannelEnabled(bool enabled) override;
+      void SetOneFilePerChannelEnabled(bool enabled);
 
       /**
        * @brief Get the available channel names of the current opened file / measurement
        *
        * @return       channel names
       **/
-      std::set<std::string> GetChannelNames() const override;
+      std::set<std::string> GetChannelNames() const;
 
       /**
        * @brief Check if channel exists in measurement
@@ -179,7 +178,7 @@ namespace eCAL
        *
        * @return       true if exists, false otherwise
       **/
-      bool HasChannel(const std::string& channel_name) const override;
+      bool HasChannel(const std::string& channel_name) const;
 
       /**
        * @brief Get the channel description for the given channel
@@ -188,15 +187,15 @@ namespace eCAL
        *
        * @return              channel description
       **/
-      std::string GetChannelDescription(const std::string& channel_name) const override;
+      std::string GetChannelDescription(const std::string& channel_name) const;
 
       /**
        * @brief Set description of the given channel
        *
        * @param channel_name    channel name
        * @param description     description of the channel
       **/
-      void SetChannelDescription(const std::string& channel_name, const std::string& description) override;
+      void SetChannelDescription(const std::string& channel_name, const std::string& description);
 
       /**
        * @brief Gets the channel type of the given channel
@@ -205,15 +204,15 @@ namespace eCAL
        *
        * @return              channel type
       **/
-      std::string GetChannelType(const std::string& channel_name) const override;
+      std::string GetChannelType(const std::string& channel_name) const;
 
       /**
        * @brief Set type of the given channel
        *
        * @param channel_name  channel name
        * @param type          type of the channel
       **/
-      void SetChannelType(const std::string& channel_name, const std::string& type) override;
+      void SetChannelType(const std::string& channel_name, const std::string& type);
 
       /**
        * @brief Gets minimum timestamp for specified channel
@@ -222,7 +221,7 @@ namespace eCAL
        *
        * @return                minimum timestamp value
       **/
-      long long GetMinTimestamp(const std::string& channel_name) const override;
+      long long GetMinTimestamp(const std::string& channel_name) const;
 
       /**
        * @brief Gets maximum timestamp for specified channel
@@ -231,7 +230,7 @@ namespace eCAL
        *
        * @return                maximum timestamp value
       **/
-      long long GetMaxTimestamp(const std::string& channel_name) const override;
+      long long GetMaxTimestamp(const std::string& channel_name) const;
 
       /**
        * @brief Gets the header info for all data entries for the given channel
@@ -242,7 +241,7 @@ namespace eCAL
        *
        * @return                    true if succeeds, false if it fails
       **/
-      bool GetEntriesInfo(const std::string& channel_name, measurement::base::EntryInfoSet& entries) const override;
+      bool GetEntriesInfo(const std::string& channel_name, measurement::base::EntryInfoSet& entries) const;
 
       /**
        * @brief Gets the header info for data entries for the given channel included in given time range (begin->end)
@@ -255,7 +254,7 @@ namespace eCAL
        *
        * @return                   true if succeeds, false if it fails
       **/
-      bool GetEntriesInfoRange(const std::string& channel_name, long long begin, long long end, measurement::base::EntryInfoSet& entries) const override;
+      bool GetEntriesInfoRange(const std::string& channel_name, long long begin, long long end, measurement::base::EntryInfoSet& entries) const;
 
       /**
        * @brief Gets data size of a specific entry
@@ -265,7 +264,7 @@ namespace eCAL
        *
        * @return                 true if succeeds, false if it fails
       **/
-      bool GetEntryDataSize(long long entry_id, size_t& size) const override;
+      bool GetEntryDataSize(long long entry_id, size_t& size) const;
 
       /**
        * @brief Gets data from a specific entry
@@ -275,14 +274,14 @@ namespace eCAL
        *
        * @return                 true if succeeds, false if it fails
       **/
-      bool GetEntryData(long long entry_id, void* data) const override;
+      bool GetEntryData(long long entry_id, void* data) const;
 
       /**
        * @brief Set measurement file base name (desired name for the actual hdf5 files that will be created)
        *
        * @param base_name        Name of the hdf5 files that will be created.
       **/
-      void SetFileBaseName(const std::string& base_name) override;
+      void SetFileBaseName(const std::string& base_name);
 
       /**
        * @brief Add entry to file
@@ -297,19 +296,24 @@ namespace eCAL
        *
        * @return              true if succeeds, false if it fails
       **/
-      bool AddEntryToFile(const void* data, const unsigned long long& size, const long long& snd_timestamp, const long long& rcv_timestamp, const std::string& channel_name, long long id, long long clock) override;
+      bool AddEntryToFile(const void* data, const unsigned long long& size, const long long& snd_timestamp, const long long& rcv_timestamp, const std::string& channel_name, long long id, long long clock);
+
+      /**
+       * @brief Callback function type for pre file split notification
+      **/
+      typedef std::function<void(void)> CallbackFunction;
 
       /**
        * @brief Connect callback for pre file split notification
        *
        * @param cb   callback function
       **/
-      void ConnectPreSplitCallback(CallbackFunction cb) override;
+      void ConnectPreSplitCallback(CallbackFunction cb);
 
       /**
        * @brief Disconnect pre file split callback
       **/
-      void DisconnectPreSplitCallback() override;
+      void DisconnectPreSplitCallback();
 
      private:
       std::unique_ptr<HDF5MeasImpl> hdf_meas_impl_;