NI Bluetooth Analysis Toolkit

niBTSA_TxPGetAveragePvTTrace

  • Updated2023-02-21
  • 2 minute(s) read

int32 __stdcall niBTSA_TxPGetAveragePvTTrace (niBTSASession session, char channelString[], float64 *x0, float64 *dx, float64 averagePvT[], int32 dataArraySize, int32 *actualArraySize);

Purpose

Returns the average power versus time trace. The toolkit averages the trace over the number of acquisitions specified by the NIBTSA_TXP_NUMBER OF_AVERAGES attribute.

Parameters

Input
Name Type Description
session niBTSASession Specifies the niBT SA session. Use this parameter to configure the behavior and operation of the appropriate NI Bluetooth Analysis Toolkit function that accepts the niBTSASession as an input.
channelString char[] Set this parameter to "" (empty string) or NULL.
dataArraySize int32 Specifies the size of the averagePvT array.
Output
Name Type Description
x0 float64* Returns the starting time, in seconds, of the PvT trace, where the start of packet corresponds to 0 seconds.
dx float64* Returns the time interval, in seconds, between data points in the PvT trace.
averagePvT float64[] Returns the array of average power of the signal. This value is expressed in dBm.
actualArraySize int32* Returns the actual number of elements populated in the averagePvT array. If the array is not large enough to hold all the samples, the function returns an error and the actualArraySize parameter returns the minimum expected size of the output array.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an niBT SA function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the niBTSA_GetErrorString function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience