RecorderPtr Class Reference

Recorders represent objects which record input data to a persistent storage medium such as a file, database, or cloud storage bucket. Recorders implement the IRecorder interface and may expose additional properties for configuring the storage (such as file type, storage location, etc.). tags. More...

Inherits ObjectPtr< IRecorder >.

Detailed Description

Recorders represent objects which record input data to a persistent storage medium such as a file, database, or cloud storage bucket. Recorders implement the IRecorder interface and may expose additional properties for configuring the storage (such as file type, storage location, etc.). tags.

Public Member Functions
void	startRecording () const
	Starts recording data from connected signals to the persistent storage medium. More...
void	stopRecording () const
	Stops recording data from connected signals to the persistent storage medium. More...
daq::Bool	getIsRecording () const
	Checks whether data from connected signals is currently being recorded to the persistent storage medium. More...

Member Function Documentation

getIsRecording()

daq::Bool getIsRecording ( ) const

inline

Checks whether data from connected signals is currently being recorded to the persistent storage medium.

Returns

A pointer to a boolean which is populated with the recording state.

Return values

OPENDAQ_SUCCESS

if the recording status was successfully returned.

startRecording()

void startRecording ( ) const

inline

Starts recording data from connected signals to the persistent storage medium.

Return values

OPENDAQ_SUCCESS

if the recording successfully started.

Exceptions

InvalidStateException

if the recording has already been started and the * implementation chooses to treat this scenario as an error.

stopRecording()

void stopRecording ( ) const

inline

Stops recording data from connected signals to the persistent storage medium.

Return values

OPENDAQ_SUCCESS

if the recording successfully stopped.

Exceptions

InvalidStateException

if the recording is not started and the implementation * chooses to treat this scenario as an error.