DFX Extraction library v4.12.0
enabling applications to perform DFX blood flow analysis
Public Member Functions | List of all members
dfx::ChunkData Class Referenceabstract

ChunkData is the internal memory representation of a Collection from which a ChunkPayload can be constructed to send to the DFX API. More...

#include "dfx/ChunkData.h"

Public Member Functions

virtual ~ChunkData ()
 ChunkData destructor.
 
virtual ChunkPayload getChunkPayload ()=0
 The measurement payload chunk of bytes to send for the current request. More...
 

Detailed Description

ChunkData is the internal memory representation of a Collection from which a ChunkPayload can be constructed to send to the DFX API.

The ChunkData enables the Collector to quickly reset it's internal state between measurement chunks by handing the collected data to ChunkData.

Building the actual ChunkPayload takes some effort and time for which the Collector would otherwise be unable to start adding frames until the previous ChunkPayload had been constructed and the Collector reset.

Member Function Documentation

◆ getChunkPayload()

virtual ChunkPayload dfx::ChunkData::getChunkPayload ( )
pure virtual

The measurement payload chunk of bytes to send for the current request.

The measurement is collapsed and summarized into the payload information necessary for the server to construct the requested signal(s).

Returns
a vector of bytes to be passed by the client application to the server for the current measurement request

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