.github/workflows/ci.yml

@@ -189,8 +189,8 @@ jobs:
       run: |
         cd build/bin
         valgrind --tool=memcheck --leak-check=full ./circular_buffer_example
-        valgrind --tool=memcheck --leak-check=full ./telemetry_buffer_example
-        valgrind --tool=memcheck --leak-check=full ./telemetry_buffer_manager_conf_file_example
-        valgrind --tool=memcheck --leak-check=full ./telemetry_buffer_manager_example
-        valgrind --tool=memcheck --leak-check=full ./telemetry_buffer_periodic_save
+        valgrind --tool=memcheck --leak-check=full ./robometry_buffer_example
+        valgrind --tool=memcheck --leak-check=full ./robometry_buffer_manager_conf_file_example
+        valgrind --tool=memcheck --leak-check=full ./robometry_buffer_manager_example
+        valgrind --tool=memcheck --leak-check=full ./robometry_buffer_periodic_save
 

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [1.2.0] - 2022-08-31
+
+- Added `units_of_measure` parameter.
+
 ## [1.1.0] - 2022-06-09
 
 - Added doxygen documentation available at https://robotology.github.io/robometry/index.html.

README.md

@@ -130,6 +130,7 @@ buffer_manager_test.one =
               data: [1×3 int32]
         dimensions: [1 3]
     elements_names: {'element_0'}
+  units_of_measure: {'n.d.'}
               name: 'one'
         timestamps: [1.6481e+09 1.6481e+09 1.6481e+09]
 ```
@@ -142,7 +143,7 @@ Here is the code snippet for dumping in a `.mat` file 3 samples of the 4x1 vecto
 ```c++
     robometry::BufferConfig bufferConfig;
     bufferConfig.auto_save = true; // It will save when invoking the destructor
-    bufferConfig.channels = { {"one",{4,1}}, {"two",{4,1}} };
+    bufferConfig.channels = { {"one", {4,1}, {}, {"meters"}}, {"two", {4,1}, {}, {"degrees"}} };
     bufferConfig.filename = "buffer_manager_test_vector";
     bufferConfig.n_samples = 3;
 
@@ -174,6 +175,7 @@ ans =
               data: [4×1×3 double]
         dimensions: [4 1 3]
     elements_names: {4×1 cell}
+  units_of_measure: {4×1 cell}
               name: 'one'
         timestamps: [1.6481e+09 1.6481e+09 1.6481e+09]
 
@@ -188,11 +190,22 @@ ans =
     {'element_1'}
     {'element_2'}
     {'element_3'}
+
+>> buffer_manager_test_vector.one.units_of_measure
+
+ans =
+
+  4×1 cell array
+
+    {'m'}
+    {'m'}
+    {'m'}
+    {'m'}
 ```
 
 It is also possible to specify the name of the elements of each variable with
 ```c++
-robometry::ChannelInfo var_one{ "one", {4,1}, {"A", "B", "C", "D"}};
+robometry::ChannelInfo var_one{ "one", {4,1}, {"A", "B", "C", "D"}, {"m", "cm", "mm", "nm"}};
 ```
 
 
@@ -366,6 +379,7 @@ ans =
               data: {1×3 cell}
         dimensions: [1 3]
     elements_names: {'element_0'}
+  units_of_measure: {'n.d.'}
               name: 'string_channel'
         timestamps: [1.6512e+09 1.6512e+09 1.6512e+09]
 
@@ -378,6 +392,7 @@ ans =
               data: [4×1×3 double]
         dimensions: [4 1 3]
     elements_names: {4×1 cell}
+  units_of_measure: {'n.d.'}
               name: 'vector_channel'
         timestamps: [1.6512e+09 1.6512e+09 1.6512e+09]
 
@@ -436,12 +451,14 @@ Where the file has to have this format:
     {
       "dimensions": [1,1],
       "elements_names": ["element_0"],
-      "name": "one"
+      "name": "one",
+      "units_of_measure": ["meters"]
     },
     {
       "dimensions": [1,1],
       "elements_names": ["element_0"],
-      "name": "two"
+      "name": "two",
+      "units_of_measure": ["degrees"]
     }
   ],
   "enable_compression": true,

docs/config.toml

@@ -3,6 +3,11 @@ main_page = "README.md"
 additional_pages = ["docs/pages/magnitude_frequency_table.md", "CHANGELOG.md", "src/telemetryDeviceDumper/"]
 src_folder = "src"
 
+['v1.1.0']
+main_page = "README.md"
+additional_pages = ["docs/pages/magnitude_frequency_table.md", "CHANGELOG.md", "src/telemetryDeviceDumper/"]
+src_folder = "src"
+
 ['v1.0.0']
 main_page = "README.md"
 additional_pages = ["docs/pages/magnitude_frequency_table.md", "CHANGELOG.md", "src/telemetryDeviceDumper/"]

src/examples/CMakeLists.txt

@@ -9,10 +9,10 @@ set(CIRCULAR_BUFFER_RECORD_EXAMPLE_SRC circular_buffer_record_example.cpp)
 set(MATIO_VECTOR_EXAMPLE_SRC matio_vector_example.cpp)
 set(MATIO_MATRIX_EXAMPLE_SRC matio_matrix_example.cpp)
 set(MATIO_TIMESERIES_EXAMPLE_SRC matio_timeseries_example.cpp)
-set(TELEMETRY_BUFFER_EXAMPLE_SRC telemetry_buffer_example.cpp)
-set(TELEMETRY_BUFFER_MANAGER_CONF_FILE telemetry_buffer_manager_conf_file.cpp)
-set(TELEMETRY_BUFFER_MANAGER_EXAMPLE_SRC telemetry_buffer_manager_example.cpp)
-set(TELEMETRY_BUFFER_PERIODIC_SAVE_SRC telemetry_buffer_periodic_save.cpp)
+set(ROBOMETRY_BUFFER_EXAMPLE_SRC robometry_buffer_example.cpp)
+set(ROBOMETRY_BUFFER_MANAGER_CONF_FILE robometry_buffer_manager_conf_file.cpp)
+set(ROBOMETRY_BUFFER_MANAGER_EXAMPLE_SRC robometry_buffer_manager_example.cpp)
+set(ROBOMETRY_BUFFER_PERIODIC_SAVE_SRC robometry_buffer_periodic_save.cpp)
 set(CB_TO_MATIO_EXAMPLE_SRC CB_to_matfile_example.cpp)
 
 
@@ -21,27 +21,27 @@ add_executable(circular_buffer_record_example ${CIRCULAR_BUFFER_RECORD_EXAMPLE_S
 add_executable(matio_vector_example ${MATIO_VECTOR_EXAMPLE_SRC})
 add_executable(matio_matrix_example ${MATIO_MATRIX_EXAMPLE_SRC})
 add_executable(matio_timeseries_example ${MATIO_TIMESERIES_EXAMPLE_SRC})
-add_executable(telemetry_buffer_example ${TELEMETRY_BUFFER_EXAMPLE_SRC})
-add_executable(telemetry_buffer_manager_conf_file_example ${TELEMETRY_BUFFER_MANAGER_CONF_FILE})
-add_executable(telemetry_buffer_manager_example ${TELEMETRY_BUFFER_MANAGER_EXAMPLE_SRC})
-add_executable(telemetry_buffer_periodic_save ${TELEMETRY_BUFFER_PERIODIC_SAVE_SRC})
+add_executable(robometry_buffer_example ${ROBOMETRY_BUFFER_EXAMPLE_SRC})
+add_executable(robometry_buffer_manager_conf_file_example ${ROBOMETRY_BUFFER_MANAGER_CONF_FILE})
+add_executable(robometry_buffer_manager_example ${ROBOMETRY_BUFFER_MANAGER_EXAMPLE_SRC})
+add_executable(robometry_buffer_periodic_save ${ROBOMETRY_BUFFER_PERIODIC_SAVE_SRC})
 add_executable(CB_to_matfile_example ${CB_TO_MATIO_EXAMPLE_SRC})
 
 target_compile_features(circular_buffer_example PUBLIC cxx_std_17)
 target_compile_features(circular_buffer_record_example PUBLIC cxx_std_17)
-target_compile_features(telemetry_buffer_example PUBLIC cxx_std_17)
-target_compile_features(telemetry_buffer_manager_conf_file_example PUBLIC cxx_std_17)
-target_compile_features(telemetry_buffer_manager_example PUBLIC cxx_std_17)
-target_compile_features(telemetry_buffer_periodic_save PUBLIC cxx_std_17)
+target_compile_features(robometry_buffer_example PUBLIC cxx_std_17)
+target_compile_features(robometry_buffer_manager_conf_file_example PUBLIC cxx_std_17)
+target_compile_features(robometry_buffer_manager_example PUBLIC cxx_std_17)
+target_compile_features(robometry_buffer_periodic_save PUBLIC cxx_std_17)
 
 
 target_link_libraries(circular_buffer_example Boost::boost)
 target_link_libraries(circular_buffer_record_example Boost::boost
                                                      robometry::robometry)
-target_link_libraries(telemetry_buffer_example robometry::robometry)
-target_link_libraries(telemetry_buffer_manager_conf_file_example robometry::robometry)
-target_link_libraries(telemetry_buffer_manager_example robometry::robometry)
-target_link_libraries(telemetry_buffer_periodic_save robometry::robometry)
+target_link_libraries(robometry_buffer_example robometry::robometry)
+target_link_libraries(robometry_buffer_manager_conf_file_example robometry::robometry)
+target_link_libraries(robometry_buffer_manager_example robometry::robometry)
+target_link_libraries(robometry_buffer_periodic_save robometry::robometry)
 target_link_libraries(matio_vector_example PRIVATE matioCpp::matioCpp)
 target_link_libraries(matio_matrix_example PRIVATE matioCpp::matioCpp)
 target_link_libraries(matio_timeseries_example PRIVATE matioCpp::matioCpp)