Generic chunk data interface. More...

#include <PvChunkData.h>

Public Member Functions
virtual void	ResetChunks ()=0
	See PvBuffer::ResetChunks. More...

virtual PvResult	AddChunk (uint32_t aID, const uint8_t *aData, uint32_t aLength)=0
	See PvBuffer::AddChunk. More...

virtual void	SetChunkLayoutID (uint32_t aChunkLayoutID)=0
	Set the chunk data layout ID. More...

virtual bool	HasChunks () const =0
	Returns true if the buffer has data chunks. More...

virtual uint32_t	GetChunkCount ()=0
	See PvBuffer::GetChunkCount. More...

virtual PvResult	GetChunkIDByIndex (uint32_t aIndex, uint32_t &aID)=0
	See PvBuffer::GetChunkIDByIndex. More...

virtual uint32_t	GetChunkSizeByIndex (uint32_t aIndex)=0
	See PvBuffer::GetChunkSizeByIndex. More...

virtual uint32_t	GetChunkSizeByID (uint32_t aID)=0
	See PvBuffer::GetChunkSizeByID. More...

virtual const uint8_t *	GetChunkRawDataByIndex (uint32_t aIndex)=0
	See PvBuffer::GetChunkRawDataByIndex. More...

virtual const uint8_t *	GetChunkRawDataByID (uint32_t aID)=0
	See PvBuffer::GetChunkRawDataByID. More...

virtual uint32_t	GetChunkLayoutID ()=0
	Get the chunk data layout ID. More...

virtual uint32_t	GetChunkDataSize () const =0
	Returns the current chunk data size. More...

virtual uint32_t	GetChunkDataCapacity () const =0
	Returns the current chunk data capacity. More...

Detailed Description

Generic chunk data interface.

Member Function Documentation

◆ AddChunk()

virtual PvResult IPvChunkData::AddChunk	(	uint32_t	aID,
		const uint8_t *	aData,
		uint32_t	aLength
	)

pure virtual

See PvBuffer::AddChunk.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters

[in]	aID	Chunk data ID for aIndex.
[in]	aData	Payload data of the chunk data.
[in]	aLength	Length of the payload data of the chunk, in bytes. Must be a multiple of 4 bytes.

Returns

A PvResult is used to capture the success or failure of the operation:

PvResult::Code::OK
PvResult::Code::BUFFER_TOO_SMALL There is not enough space in the buffer to add the chunk data.
PvResult::Code::INVALID_PARAMETER One of the input arguments is invalid.

Implemented in PvBuffer.

◆ GetChunkCount()

uint32_t IPvChunkData::GetChunkCount ( )

pure virtual

See PvBuffer::GetChunkCount.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Returns: Data chunks count. 0 if no chunks are available.

Implemented in PvBuffer.

◆ GetChunkDataCapacity()

virtual uint32_t IPvChunkData::GetChunkDataCapacity ( ) const

pure virtual

Returns the current chunk data capacity.

In a transmission context where you create the buffer, memory is allocated for chunks. This method returns how many bytes can still be added as chunk data.

One chunk is always made of 8-bytes of headers plus the chunk data length. You also need to reserve another 8-bytes for the main chunk (typically the image) unless you buffer only contains chunk data.

This method has no use in a reception context where the data receiver delivers the buffer. Use either the direct chunk access methods or the GenApi interface of the device to access chunk data.

Returns: Chunk data capacity.

Implemented in PvBuffer.

◆ GetChunkDataSize()

virtual uint32_t IPvChunkData::GetChunkDataSize ( ) const

pure virtual

Returns the current chunk data size.

In a transmission context this method returns how many bytes are used for extra chunk data. It includes the chunk headers for all chunk data and if applicable the chunk header for the main chunk (typically the image).

This method has no use in a reception context where the data receiver delivers the buffer. Use either the direct chunk access methods or the GenApi interface of the device to access chunk data.

Returns: Chunk data size in bytes.

Implemented in PvBuffer.

◆ GetChunkIDByIndex()

PvResult IPvChunkData::GetChunkIDByIndex	(	uint32_t	aIndex,
		uint32_t &	aID
	)

pure virtual

See PvBuffer::GetChunkIDByIndex.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters

[in]	aIndex	Data chunk index.
[out]	aID	Data chunk ID for aIndex.

Returns

A PvResult is used to captured the success or failure of the operation as 0 can be a valid chunk ID:

PvResult::Code::OK
PvResult::Code::NOT_FOUND if the index is out of range or the buffer does not have any chunks

Implemented in PvBuffer.

◆ GetChunkLayoutID()

uint32_t IPvChunkData::GetChunkLayoutID ( )

pure virtual

Get the chunk data layout ID.

Returns: The current chunk data layout ID.

Implemented in PvBuffer.

◆ GetChunkRawDataByID()

const uint8_t * IPvChunkData::GetChunkRawDataByID ( uint32_t aID )

pure virtual

See PvBuffer::GetChunkRawDataByID.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters

[in] aID Data chunk ID.

Returns: Pointer to chunk data. NULL if the chunk ID is not found.

Implemented in PvBuffer.

◆ GetChunkRawDataByIndex()

const uint8_t * IPvChunkData::GetChunkRawDataByIndex ( uint32_t aIndex )

pure virtual

See PvBuffer::GetChunkRawDataByIndex.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters

[in] aIndex Data chunk index.

Returns: Pointer to chunk data. NULL if the index is out of range.

Implemented in PvBuffer.

◆ GetChunkSizeByID()

uint32_t IPvChunkData::GetChunkSizeByID ( uint32_t aID )

pure virtual

See PvBuffer::GetChunkSizeByID.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters

[in] aID Data chunk ID.

Returns: Data chunk size. 0 if the chunk ID is not found.

Implemented in PvBuffer.

◆ GetChunkSizeByIndex()

uint32_t IPvChunkData::GetChunkSizeByIndex ( uint32_t aIndex )

pure virtual

See PvBuffer::GetChunkSizeByIndex.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Parameters

[in] aIndex Data chunk index.

Returns: Data chunk size. 0 if the index is out of range.

Implemented in PvBuffer.

◆ HasChunks()

bool IPvChunkData::HasChunks ( ) const

pure virtual

Returns true if the buffer has data chunks.

Unlike GetChunkCount, chunks do not need to be parsed or resolved with this method.

Returns: True if the buffer holds data chunks, false if not.

Implemented in PvBuffer.

◆ ResetChunks()

virtual void IPvChunkData::ResetChunks ( )

pure virtual

See PvBuffer::ResetChunks.

Same as PvBuffer equivalent. Provided with this interface for convenience.

Implemented in PvBuffer.

◆ SetChunkLayoutID()

void IPvChunkData::SetChunkLayoutID ( uint32_t aChunkLayoutID )

pure virtual

Set the chunk data layout ID.

See PvBuffer::AddChunk.

Parameters

[in] aChunkLayoutID Chunk data layout ID.

Set the chunk data layout ID.

Implemented in PvBuffer.

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

PvChunkData.h
PvChunkData.cpp

eBUS SDK v6.4.0.6670 API

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddChunk()

◆ GetChunkCount()

◆ GetChunkDataCapacity()

◆ GetChunkDataSize()

◆ GetChunkIDByIndex()

◆ GetChunkLayoutID()

◆ GetChunkRawDataByID()

◆ GetChunkRawDataByIndex()

◆ GetChunkSizeByID()

◆ GetChunkSizeByIndex()

◆ HasChunks()

◆ ResetChunks()

◆ SetChunkLayoutID()