Pleora Technologies Inc. eBUS SDK v7.0.1.7536 API



Loading...
Searching...
No Matches
Public Member Functions | List of all members
IPvGenDCChunkWriter Class Referenceabstract

Generic chunk data writer interface for GenDC parts. More...

#include <PvGenDCInterfaces.h>

Public Member Functions

virtual PvResult AddChunk (uint32_t aID, const uint8_t *aData, uint32_t aLength)=0
 Add chunk data to the buffer.
 
virtual void ResetChunks ()=0
 Resets the internal chunk state.
 

Detailed Description

Generic chunk data writer interface for GenDC parts.

This interface provides access to the chunk writer for a compatible GenDC part

Member Function Documentation

◆ AddChunk()

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

Add chunk data to the buffer.

Add chunk data to the buffer payload section by specifying the ID of the chunk data.

See ResetChunks for more information.

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:

◆ ResetChunks()

virtual void IPvGenDCChunkWriter::ResetChunks ( )
pure virtual

Resets the internal chunk state.

Used when creating a GenDC Part with chunks for transmission. This method should always be called before adding the first chunk block to a buffer. It removes chunk data from the previous sequence of AddChunk.

If you are adding more than one chunk block to a Part, you would normally perform this sequence for every Part setup for transmission: 

- lPart->GetGenDCChunkWriter()->ResetChunks();
- lPart->GetGenDCChunkWriter()->AddChunk( CHUNKID1, lData1, sizeof( lData1 ) );
- lPart->GetGenDCChunkWriter()->AddChunk( CHUNKID2, lData2, sizeof( lData2 ) );
The documentation for this class was generated from the following file:

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