Change saveTravelSpeeds -> saveTravelData

Author: Grufoony

README.md

@@ -49,9 +49,9 @@ cmake --install build
 ```
 
 ## Installation via Pybind11
-If you want to use the library from Python, you can build the Python bindings using [pybind11](https://github.com/pybind/pybind11). Make sure you have Python and pybind11 installed:
+If you want to use the library from Python, you can build the Python bindings using [pybind11](https://github.com/pybind/pybind11). Make sure you have doxygen installed to generate the docstrings:
 ```shell
-pip install pybind11
+sudo apt install doxygen
 ```
 
 Then, the installation is automatic via `pip`:

src/dsf/binding.cpp

@@ -396,11 +396,11 @@ PYBIND11_MODULE(dsf, m) {
            pybind11::arg("reset") = false,
            pybind11::arg("separator") = ';',
            dsf::g_docstrings.at("dsf::RoadDynamics::saveOutputStreetCounts").c_str())
-      .def("saveTravelSpeeds",
-           &dsf::FirstOrderDynamics::saveTravelSpeeds,
+      .def("saveTravelData",
+           &dsf::FirstOrderDynamics::saveTravelData,
            pybind11::arg("filename"),
            pybind11::arg("reset") = false,
-           dsf::g_docstrings.at("dsf::RoadDynamics::saveTravelSpeeds").c_str())
+           dsf::g_docstrings.at("dsf::RoadDynamics::saveTravelData").c_str())
       .def("saveMacroscopicObservables",
            &dsf::FirstOrderDynamics::saveMacroscopicObservables,
            pybind11::arg("filename"),

src/dsf/dsf.hpp

@@ -5,7 +5,7 @@
 #include <format>
 
 static constexpr uint8_t DSF_VERSION_MAJOR = 3;
-static constexpr uint8_t DSF_VERSION_MINOR = 2;
+static constexpr uint8_t DSF_VERSION_MINOR = 3;
 static constexpr uint8_t DSF_VERSION_PATCH = 0;
 
 static auto const DSF_VERSION =

src/dsf/headers/RoadDynamics.hpp

@@ -344,10 +344,15 @@ namespace dsf {
     void saveOutputStreetCounts(const std::string& filename,
                                 bool reset = false,
                                 char const separator = ';');
-    /// @brief Save the travel speeds of the agents in csv format
+    /// @brief Save the travel data of the agents in csv format.
+    /// @details The file contains the following columns:
+    /// - time: the time of the simulation
+    /// - distances: the travel distances of the agents
+    /// - times: the travel times of the agents
+    /// - speeds: the travel speeds of the agents
     /// @param filename The name of the file
     /// @param reset If true, the travel speeds are cleared after the computation
-    void saveTravelSpeeds(const std::string& filename, bool reset = false);
+    void saveTravelData(const std::string& filename, bool reset = false);
     /// @brief Save the main macroscopic observables in csv format
     /// @param filename The name of the file
     /// @param separator The separator character (default is ';')
@@ -2326,22 +2331,37 @@ namespace dsf {
   }
   template <typename delay_t>
     requires(is_numeric_v<delay_t>)
-  void RoadDynamics<delay_t>::saveTravelSpeeds(const std::string& filename, bool reset) {
+  void RoadDynamics<delay_t>::saveTravelData(const std::string& filename, bool reset) {
     bool bEmptyFile{false};
     {
       std::ifstream file(filename);
       bEmptyFile = file.peek() == std::ifstream::traits_type::eof();
     }
     std::ofstream file(filename, std::ios::app);
     if (!file.is_open()) {
-      Logger::error(std::format("Error opening file \"{}\" for writing.", filename));
+      throw std::runtime_error(Logger::buildExceptionMessage(
+          "Error opening file \"" + filename + "\" for writing."));
     }
     if (bEmptyFile) {
-      file << "time;speeds" << std::endl;
+      file << "time;distances;times;speeds" << std::endl;
     }
     file << this->time() << ';';
     for (auto it = m_travelDTs.cbegin(); it != m_travelDTs.cend(); ++it) {
-      file << std::fixed << std::setprecision(2) << it->first / it->second;
+      file << std::format("{:.2f}", it->first);
+      if (it != m_travelDTs.cend() - 1) {
+        file << ',';
+      }
+    }
+    file << ';';
+    for (auto it = m_travelDTs.cbegin(); it != m_travelDTs.cend(); ++it) {
+      file << it->second;
+      if (it != m_travelDTs.cend() - 1) {
+        file << ',';
+      }
+    }
+    file << ';';
+    for (auto it = m_travelDTs.cbegin(); it != m_travelDTs.cend(); ++it) {
+      file << std::format("{:.2f}", it->first / it->second);
       if (it != m_travelDTs.cend() - 1) {
         file << ',';
       }