Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvChunkData Class Referenceabstract

Generic chunk data interface. More...

Public Member Functions

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...
 

Detailed Description

Generic chunk data interface.

Member Function Documentation

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]aIDChunk data ID for aIndex.
[in]aDataPayload data of the chunk data.
[in]aLengthLength 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:

Implemented in PvBuffer.

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.

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]aIndexData chunk index.
[out]aIDData 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:

Implemented in PvBuffer.

uint32_t IPvChunkData::GetChunkLayoutID ( )
pure virtual

Get the chunk data layout ID.

Returns
The current chunk data layout ID.

Implemented in PvBuffer.

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]aIDData chunk ID.
Returns
Pointer to chunk data. NULL if the chunk ID is not found.

Implemented in PvBuffer.

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]aIndexData chunk index.
Returns
Pointer to chunk data. NULL if the index is out of range.

Implemented in PvBuffer.

uint32_t IPvChunkData::GetChunkSizeByID ( uint32_t  aID)
pure virtual

See PvBuffer::GetChunkSizeByID.

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

Parameters
[in]aIDData chunk ID.
Returns
Data chunk size. 0 if the chunk ID is not found.

Implemented in PvBuffer.

uint32_t IPvChunkData::GetChunkSizeByIndex ( uint32_t  aIndex)
pure virtual

See PvBuffer::GetChunkSizeByIndex.

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

Parameters
[in]aIndexData chunk index.
Returns
Data chunk size. 0 if the index is out of range.

Implemented in PvBuffer.

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.

void IPvChunkData::SetChunkLayoutID ( uint32_t  aChunkLayoutID)
pure virtual

Set the chunk data layout ID.

Parameters
[in]aChunkLayoutIDChunk data layout ID.

Implemented in PvBuffer.


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

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com