adtf::services::ant::IRecordingFile Class Reference

#include <recording_file_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::services::bat::IRecordingFile.

Public Member Functions
	ADTF_IID (IRecordingFile, "recording_file.ant.system.adtf.iid")
	definiton of interface id
virtual tResult	SetDescription (const char *strDescription)=0
virtual tResult	SetTargetFileName (const char *strFileName)=0
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
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
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Interface for manipulating recording files.

Member Function Documentation

AddExtension()

virtual tResult adtf::services::ant::IRecordingFile::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]	strName	The identifier of the extension.
[in]	oData	The raw data of the extension.
[in]	ui32UserId	An optional user id.
[in]	ui32TypeId	An optional type id.
[in]	ui32VersionId	An optional version id.

Returns

Standard result.

GetExtensionStream()

virtual tResult adtf::services::ant::IRecordingFile::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]	strName	The identifier of the extension.
[in]	ui32UserId	An optional user id.
[in]	ui32TypeId	An optional type id.
[in]	ui32VersionId	An optional version id.
[out]	pStream	This will be set to the stream interface pointer.

Returns

Standard result.

SetDescription()

virtual tResult adtf::services::ant::IRecordingFile::SetDescription ( const char * strDescription )

pure virtual

Set the description in the file header.

Parameters

[in]

strDescription

The description.

Returns

Standard result.

SetTargetFileName()

virtual tResult adtf::services::ant::IRecordingFile::SetTargetFileName ( const char * strFileName )

pure virtual

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

Parameters

[in]

strFileName

The target filename.

Returns

Standard result.

---

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

• src/libraries/base/include/plugins/recording_file_intf.h