rtctk::componentFramework::RepositoryRecordingUnit Class Reference

Recording Unit that can record multiple repository datapoints including metadata. More...

#include <repositoryRecordingUnit.hpp>

Inheritance diagram for rtctk::componentFramework::RepositoryRecordingUnit:

Public Member Functions
	RepositoryRecordingUnit (const std::string &comp_id, const std::string &unit_id, ServiceContainer &services)
	Create a new recording unit.
	~RepositoryRecordingUnit () override
	Destructor.
void	Prepare (const std::filesystem::path &file_path) override
	Prepare the recording.
void	Start () override
	Start the recording.
std::vector< std::filesystem::path >	Stop () override
	Stop the recording and wait for it's termination.
Public Member Functions inherited from rtctk::componentFramework::RecordingUnit
	RecordingUnit (const std::string &comp_id, const std::string &unit_id, const std::string &unit_type, ServiceContainer &services)
	Create a new RecordingIngestion.
	RecordingUnit ()=delete
virtual	~RecordingUnit ()=default
void	ConnectWithLeaders (RecUnitListType &units)
const std::string &	GetId () const
	Get the unit_it of this RecordingUnit.
State	GetState () const
	Get the current state of the Recording Unit.
bool	IsEnabled () const
	Checks whether the Recording Unit is enabled.
virtual void	CheckErrors ()
	Check for Errors, will rethrow errors thrown in the recorder.
virtual void	Update ()
	Update dynamic settings.
boost::signals2::connection	Connect (const std::function< void(const std::string &, const State &)> &function)
	Connect to State change signal.

Additional Inherited Members
Public Types inherited from rtctk::componentFramework::RecordingUnit
enum class	State : uint8_t {   STOPPED , PREPARING , IDLE , WAITING ,   RUNNING , FINISHED , FAILED }
Public Attributes inherited from rtctk::componentFramework::RecordingUnit
const std::map< State, std::string >	m_state_text
Protected Member Functions inherited from rtctk::componentFramework::RecordingUnit
bool	SetState (State state, State precondition)
	Sets the new state, only goes to new state, if expected state matches.
void	SetState (State state, State precondition, const std::string &error_message)
	Sets the new state, only goes to new state, if expected state matches.
void	SetFailed (const std::exception_ptr &exception)
	Set the unit into failed state, with the given exception.
void	SetStopped ()
	Set the Unit state to STOPPED independent of the current State.
bool	HasLeaders ()
	Check if this unit is following any leaders.
bool	HasFirstLeaderStarted ()
	This function is used to determine if this unit should start recording when waiting for leaders.
bool	HasLastLeaderFinished ()
	This function is used to determine if this unit should stop recording when waiting for leaders.
void	ResetLeaderStates ()
Protected Attributes inherited from rtctk::componentFramework::RecordingUnit
std::string	m_comp_id
std::string	m_unit_id
RuntimeRepoIf &	m_rtr
OldbIf &	m_oldb
ComponentMetricsIf &	m_metrics
std::optional< std::filesystem::path >	m_file_path
boost::signals2::signal< void(const std::string &, const State &)>	m_signal

Detailed Description

Recording Unit that can record multiple repository datapoints including metadata.

Constructor & Destructor Documentation

RepositoryRecordingUnit()

RepositoryRecordingUnit::RepositoryRecordingUnit	(	const std::string &	comp_id,
		const std::string &	unit_id,
		ServiceContainer &	services )

Create a new recording unit.

Parameters

comp_id	name of the component
unit_id	name of the recording unit
services	required services

~RepositoryRecordingUnit()

RepositoryRecordingUnit::~RepositoryRecordingUnit ( )

override

Destructor.

Member Function Documentation

Prepare()

void RepositoryRecordingUnit::Prepare ( const std::filesystem::path & file_path )

overridevirtual

Prepare the recording.

Parameters

file_path

file to record to

Implements rtctk::componentFramework::RecordingUnit.

Start()

void RepositoryRecordingUnit::Start ( )

overridevirtual

Start the recording.

Implements rtctk::componentFramework::RecordingUnit.

Stop()

std::vector< std::filesystem::path > RepositoryRecordingUnit::Stop ( )

overridevirtual

Stop the recording and wait for it's termination.

Returns

the created files

Implements rtctk::componentFramework::RecordingUnit.

---

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

• componentFramework/services/dataRecording/src/include/rtctk/componentFramework/repositoryRecordingUnit.hpp
• componentFramework/services/dataRecording/src/repositoryRecordingUnit.cpp