Generic chunk data interface for GenDC parts.
More...
#include <PvGenDCInterfaces.h>
Generic chunk data interface for GenDC parts.
This interface provides access to chunk data within a GenDC part
◆ GetChunkCount()
| virtual uint32_t IPvGenDCChunkData::GetChunkCount |
( |
| ) |
const |
|
pure virtual |
Returns the number of chunks.
- Returns
- Data chunks count. 0 if no chunks are available.
◆ GetChunkIDByIndex()
| virtual PvResult IPvGenDCChunkData::GetChunkIDByIndex |
( |
uint32_t |
aIndex, |
|
|
uint32_t & |
aID |
|
) |
| const |
|
pure virtual |
Get chunk ID by index.
- Parameters
-
| [in] | aIndex | Data chunk index. |
| [out] | aID | Data chunk ID for aIndex. |
- Returns
- Includes:
◆ GetChunkLayoutID()
| virtual uint32_t IPvGenDCChunkData::GetChunkLayoutID |
( |
| ) |
const |
|
pure virtual |
Get the chunk data layout ID.
- Returns
- The current chunk data layout ID.
◆ GetChunkRawDataByID()
| virtual const uint8_t* IPvGenDCChunkData::GetChunkRawDataByID |
( |
uint32_t |
aID | ) |
const |
|
pure virtual |
Get chunk raw data by ID.
- Parameters
-
- Returns
- Pointer to chunk data. NULL if the chunk ID is not found.
◆ GetChunkRawDataByIndex()
| virtual const uint8_t* IPvGenDCChunkData::GetChunkRawDataByIndex |
( |
uint32_t |
aIndex | ) |
const |
|
pure virtual |
Get chunk raw data by index.
- Parameters
-
| [in] | aIndex | Data chunk index. |
- Returns
- Pointer to chunk data. NULL if the index is out of range.
◆ GetChunkSizeByID()
| virtual uint32_t IPvGenDCChunkData::GetChunkSizeByID |
( |
uint32_t |
aID | ) |
const |
|
pure virtual |
Get chunk size by ID.
- Parameters
-
- Returns
- Data chunk size. 0 if the chunk ID is not found.
◆ GetChunkSizeByIndex()
| virtual uint32_t IPvGenDCChunkData::GetChunkSizeByIndex |
( |
uint32_t |
aIndex | ) |
const |
|
pure virtual |
Get chunk size by index.
- Parameters
-
| [in] | aIndex | Data chunk index. |
- Returns
- Data chunk size. 0 if the index is out of range.
◆ HasChunks()
| virtual bool IPvGenDCChunkData::HasChunks |
( |
| ) |
const |
|
pure virtual |
Returns true if the buffer has data chunks.
- Returns
- True if the buffer holds data chunks, false if not.
The documentation for this class was generated from the following file:
eBUS SDK v7.0.1.7536 API