dataRecorder.hpp

Go to the documentation of this file.

#ifndef RTCTK_COMPONENTFRAMEWORK_DATARECORDER_HPP
#define RTCTK_COMPONENTFRAMEWORK_DATARECORDER_HPP
 
#include <array>
#include <filesystem>
#include <gsl/span>
#include <string_view>
#include <tuple>
 
namespace rtctk::componentFramework {

template <class... T>
class DataRecorder {
public:
    struct ColumnMetaData {
        std::string_view name;
        std::string_view unit;
 
        constexpr ColumnMetaData(const std::string_view& new_name, const std::string_view& new_unit)
            : name(new_name), unit(new_unit) {
        }
    };

    using TupleType = std::tuple<T...>;

    using DisabledFields = std::array<bool, sizeof...(T)>;
    using ColumnDescription = const std::array<ColumnMetaData, sizeof...(T)>;

    explicit DataRecorder(const ColumnDescription& columns, const DisabledFields& disable = {})
        : m_disabled_fields(disable), m_column_description(columns) {
    }
 
    virtual ~DataRecorder() = default;

    void SetDisabledFields(const DisabledFields& disable) {
        m_disabled_fields = disable;
    }

    virtual void Write(const std::tuple<T...>& data) = 0;

    virtual void Write(const gsl::span<const std::tuple<T...>> data) {
        for (const auto& element : data) {
            Write(element);
        }
    }

    virtual void Open(const std::filesystem::path& file) = 0;

    virtual void Close() = 0;

    virtual std::string DefaultFileExtension() = 0;
 
protected:
    DisabledFields m_disabled_fields;
    const ColumnDescription m_column_description;
};
 
}  // namespace rtctk::componentFramework
 
#endif  // RTCTK_COMPONENTFRAMEWORK_DATARECORDER_HPP