ADTF  3.18.2
IRecordingFileabstract

Interface for manipulating recording files. More...

Inheritance diagram for IRecordingFile:
[legend]

Public Member Functions

 ADTF_IID (IRecordingFile, "recording_file.bat.system.adtf.iid")
 definiton of interface id
 
virtual tResult GetTimeRange (tTimeStamp &tmFirstItem, tTimeStamp &tmLastItem)=0
 Returns the time range of the recording. More...
 
- Public Member Functions inherited from IRecordingFile
 ADTF_IID (IRecordingFile, "recording_file.ant.system.adtf.iid")
 definiton of interface id
 
virtual tResult SetDescription (const char *strDescription)=0
 Set the description in the file header. More...
 
virtual tResult SetTargetFileName (const char *strFileName)=0
 Set the filename that the file should be moved to after it has been closed. More...
 
virtual tResult AddExtension (const char *strName, const adtf::base::ant::IRawMemory &oData, uint32_t ui32UserId=0, uint32_t ui32TypeId=0, uint32_t ui32VersionId=0)=0
 Add a new extension. More...
 
virtual tResult GetExtensionStream (const char *strName, uint32_t ui32UserId, uint32_t ui32TypeId, uint32_t ui32VersionId, adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IOutputStream > &pStream)=0
 Get a handle to a stream interface to directly write extensiond data to the file without an intermediate buffer. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Additional Inherited Members

- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Interface for manipulating recording files.

Definition at line 85 of file recording_file_intf.h.

Member Function Documentation

◆ GetTimeRange()

virtual tResult GetTimeRange ( tTimeStamp tmFirstItem,
tTimeStamp tmLastItem 
)
pure virtual

Returns the time range of the recording.

Parameters
[out]tmFirstItemchunk timestamp of the first item recorded
[out]tmLastItemchunk timestamp of the last item recorded
Returns
Standard result.