FakeRecorder< T > Class Template Reference

#include <helpers.hpp>

Inheritance diagram for FakeRecorder< 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
	FakeRecorder (const ColumnDescription &columns, const std::array< bool, sizeof...(T)> &disable={})
	~FakeRecorder ()=default
	MOCK_METHOD (void, Open,(const std::filesystem::path &),(override))
	MOCK_METHOD (void, SetColumnLength,(size_t, size_t))
	MOCK_METHOD (void, Close,(),(override))
	MOCK_METHOD (void, Write,(const std::tuple< T... > &),(override))
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 std::tuple< T... > &data)=0
	Write a single row of data.
virtual void	Write (const gsl::span< const std::tuple< T... > > data)
	Write multiple rows of data.
virtual void	Open (const std::filesystem::path &file)=0
	Open a file.
virtual void	Close ()=0
	Close the currently open file.

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

Member Typedef Documentation

ColumnDescription

template<class... T>

using FakeRecorder< T >::ColumnDescription = typename DataRecorder<T...>::ColumnDescription

Constructor & Destructor Documentation

FakeRecorder()

template<class... T>

FakeRecorder< T >::FakeRecorder ( const ColumnDescription & columns, const std::array< bool, sizeof...(T)> & disable = {} )

inlineexplicit

~FakeRecorder()

template<class... T>

FakeRecorder< T >::~FakeRecorder ( )

default

Member Function Documentation

DefaultFileExtension()

template<class... T>

std::string FakeRecorder< T >::DefaultFileExtension ( )

inlineoverridevirtual

Default filename extension for the recorder.

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

MOCK_METHOD() [1/4]

template<class... T>

FakeRecorder< T >::MOCK_METHOD	(	void	,
		Close	,
		()	,
		(override)	)

MOCK_METHOD() [2/4]

template<class... T>

FakeRecorder< T >::MOCK_METHOD	(	void	,
		Open	,
		(const std::filesystem::path &)	,
		(override)	)

MOCK_METHOD() [3/4]

template<class... T>

FakeRecorder< T >::MOCK_METHOD	(	void	,
		SetColumnLength	,
		(size_t, size_t)	)

MOCK_METHOD() [4/4]

template<class... T>

FakeRecorder< T >::MOCK_METHOD	(	void	,
		Write	,
		(const std::tuple< T... > &)	,
		(override)	)

---

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

• componentFramework/services/dataRecording/test/helpers.hpp