rtctk::componentFramework::CsvDataRecorder< T > Class Template Reference

Recorder used for writing data to a CSV file. More...

#include <csvDataRecorder.hpp>

Inheritance diagram for rtctk::componentFramework::CsvDataRecorder< T >:

Public Types
using	ColumnDescription = typename DataRecorder<T...>::ColumnDescription
Public Types inherited from rtctk::componentFramework::DataRecorder< T... >
using	TupleType
	Type of the tuple returned by user-defined method AsTuple.
using	DisabledFields
	Type for disabled fields, an array of bools with length equal to size of the data tuple.
using	ColumnDescription

Public Member Functions
	CsvDataRecorder (const ColumnDescription &columns, const std::array< bool, sizeof...(T)> &disabled={})
	Create a new recorder.
	~CsvDataRecorder () override=default
void	Open (const std::filesystem::path &file) override
	Open a file.
void	Write (const std::tuple< T... > &data) override
	Write a single row of data.
void	Close () override
	Close the currently open file.
std::string	DefaultFileExtension () override
	Default filename extension for the recorder.
Public Member Functions inherited from rtctk::componentFramework::DataRecorder< T... >
	DataRecorder (const ColumnDescription &columns, const DisabledFields &disable={})
	Create a new recorder.
virtual	~DataRecorder ()=default
void	SetDisabledFields (const DisabledFields &disable)
	Disable certain fields so that they are not recorded.
virtual void	Write (const gsl::span< const std::tuple< T... > > data)
	Write multiple rows of data.

Additional Inherited Members
Protected Attributes inherited from rtctk::componentFramework::DataRecorder< T... >
DisabledFields	m_disabled_fields
	Array of fields that should not be recorded.
const ColumnDescription	m_column_description

Detailed Description

template<class... T>
class rtctk::componentFramework::CsvDataRecorder< T >

Recorder used for writing data to a CSV file.

Member Typedef Documentation

ColumnDescription

template<class... T>

using rtctk::componentFramework::CsvDataRecorder< T >::ColumnDescription = typename DataRecorder<T...>::ColumnDescription

Constructor & Destructor Documentation

CsvDataRecorder()

template<class... T>

rtctk::componentFramework::CsvDataRecorder< T >::CsvDataRecorder ( const ColumnDescription & columns, const std::array< bool, sizeof...(T)> & disabled = {} )

explicit

Create a new recorder.

Parameters

[in]	columns	Array of table column descriptions.
[in]	disabled	Array of bools, with the boolean indicating whether fields should be skipped during the recording.

~CsvDataRecorder()

template<class... T>

rtctk::componentFramework::CsvDataRecorder< T >::~CsvDataRecorder ( )

overridedefault

Member Function Documentation

Close()

template<class... T>

void rtctk::componentFramework::CsvDataRecorder< T >::Close ( )

overridevirtual

Close the currently open file.

Implements rtctk::componentFramework::DataRecorder< T... >.

DefaultFileExtension()

template<class... T>

std::string rtctk::componentFramework::CsvDataRecorder< T >::DefaultFileExtension ( )

inlineoverridevirtual

Default filename extension for the recorder.

Implements rtctk::componentFramework::DataRecorder< T... >.

Open()

template<class... T>

void rtctk::componentFramework::CsvDataRecorder< T >::Open ( const std::filesystem::path & file )

overridevirtual

Open a file.

Parameters

[in]

file

The path to the file.

Implements rtctk::componentFramework::DataRecorder< T... >.

Write()

template<class... T>

void rtctk::componentFramework::CsvDataRecorder< T >::Write ( const std::tuple< T... > & data )

overridevirtual

Write a single row of data.

Parameters

[in]

data

The tuple containing all the data, including the disabled fields.

Implements rtctk::componentFramework::DataRecorder< T... >.

---

The documentation for this class was generated from the following files:

• componentFramework/services/dataRecording/src/include/rtctk/componentFramework/csvDataRecorder.hpp
• componentFramework/services/dataRecording/src/include/rtctk/componentFramework/csvDataRecorder.ipp