ADTF  3.14.3
IRecordingFileabstract

Interface for manipulating recording files. More...

Inheritance diagram for IRecordingFile:
[legend]

Public Member Functions

 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 21 of file recording_file_intf.h.

Member Function Documentation

◆ AddExtension()

virtual tResult AddExtension ( const char *  strName,
const adtf::base::ant::IRawMemory oData,
uint32_t  ui32UserId = 0,
uint32_t  ui32TypeId = 0,
uint32_t  ui32VersionId = 0 
)
pure virtual

Add a new extension.

Parameters
[in]strNameThe identifier of the extension.
[in]oDataThe raw data of the extension.
[in]ui32UserIdAn optional user id.
[in]ui32TypeIdAn optional type id.
[in]ui32VersionIdAn optional version id.
Returns
Standard result.

◆ GetExtensionStream()

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 
)
pure virtual

Get a handle to a stream interface to directly write extensiond data to the file without an intermediate buffer.

Parameters
[in]strNameThe identifier of the extension.
[in]ui32UserIdAn optional user id.
[in]ui32TypeIdAn optional type id.
[in]ui32VersionIdAn optional version id.
[out]pStreamThis will be set to the stream interface pointer.
Returns
Standard result.

◆ SetDescription()

virtual tResult SetDescription ( const char *  strDescription)
pure virtual

Set the description in the file header.

Parameters
[in]strDescriptionThe description.
Returns
Standard result.

◆ SetTargetFileName()

virtual tResult SetTargetFileName ( const char *  strFileName)
pure virtual

Set the filename that the file should be moved to after it has been closed.

Parameters
[in]strFileNameThe target filename.
Returns
Standard result.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)