remove DataLogger -- use Csv instead

Author: epezent

cmake/MELSources.cmake

@@ -96,7 +96,6 @@ list(APPEND MEL_DEVICES_HEADERS
 set(MEL_LOGGING_HEADERS_DIR "${MEL_HEADERS_DIR}/Logging")
 list(APPEND MEL_LOGGING_HEADERS
     "${MEL_LOGGING_HEADERS_DIR}/Csv.hpp"
-    "${MEL_LOGGING_HEADERS_DIR}/DataLogger.hpp"
     "${MEL_LOGGING_HEADERS_DIR}/File.hpp"
     "${MEL_LOGGING_HEADERS_DIR}/Log.hpp"
     "${MEL_LOGGING_HEADERS_DIR}/LogRecord.hpp"
@@ -289,7 +288,6 @@ list(APPEND MEL_DEVICES_SRC
 set(MEL_LOGGING_SRC_DIR "${MEL_SRC_DIR}/Logging")
 list(APPEND MEL_LOGGING_SRC
     "${MEL_LOGGING_SRC_DIR}/Csv.cpp"
-    "${MEL_LOGGING_SRC_DIR}/DataLogger.cpp"
     "${MEL_LOGGING_SRC_DIR}/File.cpp"
     "${MEL_LOGGING_SRC_DIR}/Log.cpp"
     "${MEL_LOGGING_SRC_DIR}/LogRecord.cpp"

examples/ex_csv.cpp

@@ -69,15 +69,17 @@ int main() {
     if (csv.is_open()) {
         // make a header
         csv.write_row("Time", "double", "string", "int", "vector[0]", "vector[1]", "vector[2]");
+        // set precision of floating poitn numbers
+        csv.set_precision(2);
         // simulate a loop
-        print("Starting 60 second loop ...");
+        print("Starting 10 second loop ...");
         Timer timer(hertz(1000));
         Time  t;
-        while (t < seconds(60)) {
+        while (t < seconds(10)) {
             // make some data
             double a_double         = random(0.0, 100.0);
             string a_string         = "string" + std::to_string(timer.get_elapsed_ticks());
-            int a_int               = random(0, 100);
+            int a_int               = random(0, 1000);
             vector<double> a_vector = {random(0.0,1.0), random(1.0,2.0), random(2.0,3.0)};
             // write a row (note a_vector will count as 3 fields)
             csv.write_row(t, a_double, a_string, a_int, a_vector);

examples/ex_filter.cpp

@@ -16,7 +16,7 @@
 // Author(s): Craig McDonald ([email protected])
 
 #include <MEL/Core/Timer.hpp>
-#include <MEL/Logging/DataLogger.hpp>
+#include <MEL/Logging/Csv.hpp>
 #include <MEL/Math/Butterworth.hpp>
 #include <MEL/Math/Filter.hpp>
 #include <MEL/Math/Functions.hpp>
@@ -46,31 +46,26 @@ int main() {
     double x = 0.5 + o;
 
     // initialize data logger to write immediately to file
-    DataLogger data_logger(WriterType::Buffered, false);
-    std::vector<std::string> header = {"Input", "LPF Output", "HPF Output",
-                                       "LPF Seeded Output",
-                                       "HPF Seeded Output"};
-    data_logger.set_header(header);
+    Csv csv("filter.csv");
+    csv.write_row("Input", "LPF Output", "HPF Output", "LPF Seeded Output", "HPF Seeded Output");
 
     // data storage container
-    std::vector<double> data_record(header.size());
+    std::vector<double> data(5);
 
     // begin filtering and logging data
     for (int i = 0; i < samples; ++i) {
         // generate input signal
         x = r * (x - o) * (1 - (x - o)) + o;
 
         // filter input signal and store data
-        data_record[0] = x;
-        data_record[1] = lp_filter.update(x);
-        data_record[2] = hp_filter.update(x);
-        data_record[3] = lps_filter.update(x);
-        data_record[4] = hps_filter.update(x);
+        data[0] = x;
+        data[1] = lp_filter.update(x);
+        data[2] = hp_filter.update(x);
+        data[3] = lps_filter.update(x);
+        data[4] = hps_filter.update(x);
 
         // write to data log buffer
-        data_logger.buffer(data_record);
+        csv.write_row(data);
     }
 
-    data_logger.save_data("example_filter_data", ".", false);
-
 }

examples/ex_math.cpp

@@ -21,7 +21,7 @@
 #include <MEL/Math/Integrator.hpp>
 #include <MEL/Core/Console.hpp>
 #include <MEL/Core/Timer.hpp>
-#include <MEL/Logging/DataLogger.hpp>
+#include <MEL/Logging/Csv.hpp>
 
 using namespace mel;
 
@@ -35,9 +35,8 @@ int main() {
     Integrator integrator = Integrator(5, Integrator::Technique::Simpsons);
 
     // create data logger
-    DataLogger data_logger(WriterType::Buffered, false);
-    std::vector<std::string> header = { "t", "x(t)", "dx/dt", "dx/dt", "integral(x)", "integral(x)" };
-    data_logger.set_header(header);
+    Csv csv("math.csv");
+    csv.write_row("t", "x(t)", "dx/dt", "dx/dt", "integral(x)", "integral(x)");
     std::vector<double> data(6);
 
     // loop
@@ -55,14 +54,11 @@ int main() {
         data[4] = mel::sin(4 * t) * mel::cos(3 * t) + 5;
         // integral(x) ~ integrate(dx/dt)
         data[5] = integrator.update(data[1], timer.get_elapsed_time());
-        // write to data log buffer
-        data_logger.buffer(data);
+        // write data to csv
+        csv.write_row(data);
         // wait timer
         timer.wait();
     }
 
-    // save data
-    data_logger.save_data("example_math_data");
-
     return 0;
 }

include/MEL/Logging/Csv.hpp

@@ -24,6 +24,7 @@
 #include <sstream>
 #include <fstream>
 #include <iomanip>
+#include <ios>
 
 namespace mel {
 
@@ -41,13 +42,19 @@ class Csv : public File {
     template <typename Arg, typename... Args>
     void write_row(Arg&& arg, Args&&... args);
 
+    /// Sets the precision of floating point values (default 6)
+    void set_precision(std::size_t precision);
+    
 private:
 
     // hide functions inherited from File
     using File::unlink;
     using File::rename;
     using File::write;
 
+private:
+
+    std::size_t precision_;  ///< precision of floating point values
 };
 
 // The following free functions are provided for convenience and are not

include/MEL/Logging/DataLogger.hpp

@@ -3,6 +3,7 @@ namespace mel {
  template <typename Arg, typename... Args>
 void Csv::write_row(Arg&& arg, Args&&... args) {
     std::ostringstream ss;
+    ss << std::setprecision(precision_);
     ss << std::forward<Arg>(arg);
     using expander = int[];
     (void)expander{0, (void(ss << ',' << std::forward<Args>(args)), 0)...};

include/MEL/Logging/Detail/Csv.inl

@@ -5,12 +5,17 @@
 namespace mel
 {    
 
-Csv::Csv() : File() {}
+Csv::Csv() : File(), precision_(6) {}
 
 Csv::Csv(const std::string &filepath, WriteMode w_mode, OpenMode o_mode) :
-    File(filepath, w_mode, o_mode)
+    File(filepath, w_mode, o_mode),
+    precision_(6)
 {
 
 }
 
+void Csv::set_precision(std::size_t precision) {
+    precision_ = precision;
+}
+
 } // mel