adtf::remote::ant::IRecorder Class Reference

#include <adtf_remote_recorder_intf.h>

Inherited by adtf::remote::bat::IRecorder.

Public Member Functions
	ADTF_IID (IRecorder, "recorder.ant.remote.adtf")
	RPC IID of the Recorder.
virtual const char *	GetCurrentFileName () const =0
virtual tResult	Start (const char *strFileName)=0
virtual tResult	Stop (const char *strFileName)=0
virtual tResult	Split (const char *strFileName)=0
virtual int8_t	GetCurrentState () const =0
virtual tTimeStamp	GetFirstTime () const =0
virtual tTimeStamp	GetLastTime () const =0

Static Public Attributes
static constexpr const tChar *const	DEFAULT_NAME = "recorder"
	Default name of the recorder.

Detailed Description

Remote Recorder interface. Use this interface to communicate to the Recorder via RPC call.

See also

Recorder

Member Function Documentation

GetCurrentFileName()

virtual const char * adtf::remote::ant::IRecorder::GetCurrentFileName ( ) const

pure virtual

Retrieves the current filename set for the file recording.

Returns

The filename set

Return values

empty

if no filename set or not recording

GetCurrentState()

virtual int8_t adtf::remote::ant::IRecorder::GetCurrentState ( ) const

pure virtual

Retrieves the current state of the recorder.

Returns

The current state (adtf::service::ant::IRecorder::tState)

See also

adtf::service::ant::IRecorder::tState

GetFirstTime()

virtual tTimeStamp adtf::remote::ant::IRecorder::GetFirstTime ( ) const

pure virtual

Retrieves the first (chunk) time of the currently recorded file.

Returns

The first (chunk) time of the currently recorded file

Return values

-1	no file recorded

GetLastTime()

virtual tTimeStamp adtf::remote::ant::IRecorder::GetLastTime ( ) const

pure virtual

Retrieves the last (chunk) time of the currently recorded files.

Returns

The last (chunk) time of the currently recorded files

Return values

-1	no file recorded

Split()

virtual tResult adtf::remote::ant::IRecorder::Split ( const char * strFileName )

pure virtual

Splits Recording.

Parameters

[in]

strFileName

optional parameter of filename where to record. Set empty ("") to use the recorders default.

Remarks

This filename must be a valid path on the host where recorder is running. The filename will override any other previous set filename.

Returns

Standard Result code

Return values

ERR_NOERROR

Splitting of recording successfully set

Start()

virtual tResult adtf::remote::ant::IRecorder::Start ( const char * strFileName )

pure virtual

Starts Recording.

Parameters

[in]

strFileName

optional parameter of filename where to record. Set empty ("") to use the recorders default.

Remarks

This filename must be a valid path on the host where recorder is running. The filename will override any other previous set filename.

Returns

Standard Result code

Return values

ERR_NOERROR

Starting of recording successfully set

Stop()

virtual tResult adtf::remote::ant::IRecorder::Stop ( const char * strFileName )

pure virtual

Stops Recording.

Parameters

[in]

strFileName

optional parameter of filename where to record. Set empty ("") to use the recorders default.

Remarks

This filename must be a valid path on the host where recorder is running. The filename will override any other previous set filename.

Returns

Standard Result code

Return values

ERR_NOERROR

Stopping of recording successfully set

---

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

• src/libraries/adtfremotesdk/include/adtfremotesdk/adtf_remote_recorder_intf.h