Data Fields
bbIQPacket Struct Reference

#include <bb_api.h>

Data Fields

void * iqData
int iqCount
int * triggers
int triggerCount
int purge
int dataRemaining
int sampleLoss
int sec
int nano

Detailed Description

Used to encapsulate I/Q data and metadata. See bbGetIQ.

Field Documentation

◆ iqData

void* iqData

Pointer to an array of 32-bit complex floating-point values. Complex values are interleaved real-imaginary pairs. This must point to a contiguous block of iqCount complex pairs.

◆ iqCount

int iqCount

Number of I/Q data pairs to return.

◆ triggers

int* triggers

pointer to an array of integers. If the external trigger input is active, and a trigger occurs during the acquisition time, triggers will be populated with values which are relative indices into the iqData array where external triggers occurred. Any unused trigger array values will be set to zero.

◆ triggerCount

int triggerCount

Size of the triggers array.

◆ purge

int purge

Specifies whether to discard any samples acquired by the API since the last time and bbGetIQ function was called. Set to BB_TRUE if you wish to discard all previously acquired data, and BB_FALSE if you wish to retrieve the contiguous I/Q values from a previous call to this function.

◆ dataRemaining

int dataRemaining

How many I/Q samples are still left buffered in the API. Set by API.

◆ sampleLoss

int sampleLoss

Returns BB_TRUE or BB_FALSE. Will return BB_TRUE when the API is required to drop data due to internal buffers wrapping. This can be caused by I/Q samples not being polled fast enough, or in instances where the processing is not able to keep up (underpowered systems, or other programs utilizing the CPU) Will return BB_TRUE on the capture in which the sample break occurs. Does not indicate which sample the break occurs on. Will always return false if purge is true. Set by API.

◆ sec

int sec

Seconds since epoch representing the timestamp of the first sample in the returned array. Set by API.

◆ nano

int nano

Nanoseconds representing the timestamp of the first sample in the returned array. Set by API.

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