NI RFmx LTE PVT Fetch Functions - ni/grpc-device GitHub Wiki

PVT Fetch Functions

RFmxLTE_PVTFetchMeasurement

int32 __stdcall RFmxLTE_PVTFetchMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus, float64* meanAbsoluteOFFPowerBefore, float64* meanAbsoluteOFFPowerAfter, float64* meanAbsoluteONPower, float64* burstWidth);

Purpose

Returns the measurement. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to read this result.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, result name, subblock number, and carrier number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
"result::r1/subblock0/carrier0"
"signal::sig1/result::r1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
measurementStatus int32* Returns the measurement status indicating whether the power before and after the burst is within the standard defined limit.
meanAbsoluteOFFPowerBefore float64* Returns the mean power in the segment before the captured burst. The segment is defined as one subframe prior to the burst for the FDD mode and 10 SCFDMA symbols prior to the burst for the TDD mode. This value is expressed in dBm.
meanAbsoluteOFFPowerAfter float64* Returns the mean power in the segment after the captured burst. This value is expressed in dBm.
The segment is defined as one subframe long excluding a transient period of 20 μs at the beginning. This value is expressed in dBm.
meanAbsoluteONPower float64* Returns the average power of the subframes within the captured burst, excluding a transient period of 20 μs at the beginning. This value is expressed in dBm.
burstWidth float64* Returns the width of the captured burst.

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 condition. Examine the status code from each call to an RFmx 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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_PVTFetchMeasurementArray

int32 __stdcall RFmxLTE_PVTFetchMeasurementArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 measurementStatus[], float64 meanAbsoluteOFFPowerBefore[], float64 meanAbsoluteOFFPowerAfter[], float64 meanAbsoluteONPower[], float64 burstWidth[], int32 arraySize, int32* actualArraySize);

Purpose

Returns the measurement array. Use "subblock<n>" as the selector string to read this result.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, result name, and subblock number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"subblock0"
"signal::sig1/subblock0"
"result::r1/subblock0"
"signal::sig1/result::r1/subblock0"
You can use the RFmxLTE_BuildSubblockString) function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
measurementStatus int32[] Returns the array of the measurement status indicating whether the power before and after the burst is within the standard defined limit.
meanAbsoluteOFFPowerBefore float64[] Returns the array of the mean power in the segment before the captured burst. The segment is defined as one subframe prior to the burst for the FDD mode and 10 SCFDMA symbols prior to the burst for the TDD mode. This value is expressed in dBm.
meanAbsoluteOFFPowerAfter float64[] Returns the array of the mean power in the segment after the captured burst. This value is expressed in dBm.
The segment is defined as one subframe long excluding a transient period of 20 μs at the beginning.
meanAbsoluteONPower float64[] Returns the array of the average power of the subframes within the captured burst, excluding a transient period of 20 μs at the beginning. This value is expressed in dBm.
burstWidth float64[] Returns the array of the width of the captured burst.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 condition. Examine the status code from each call to an RFmx 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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

RFmxLTE_PVTFetchSignalPowerTrace

int32 __stdcall RFmxLTE_PVTFetchSignalPowerTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 signalPower[], float32 absoluteLimit[], int32 arraySize, int32* actualArraySize);

Purpose

Returns the instantaneous signal power trace along with absolute limit for each segment in the trace as specified by section 6.5.2.4.5 of the 3GPP 36.521. This value is expressed in dBm. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to read this result.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the instrument session. The RFmx obtains this parameter from the RFmxLTE_Initialize) function.
selectorString char[] Specifies a selector string) comprising of the signal name, result name, subblock number, and carrier number. If you do not specify the signal name, the default signal instance is used. If you do not specify the result name, the default result instance is used.
Example:
"subblock0/carrier0"
"signal::sig1/subblock0/carrier0"
"result::r1/subblock0/carrier0"
"signal::sig1/result::r1/subblock0/carrier0"
You can use the RFmxLTE_BuildCarrierString) function to build the selector string.
timeout float64 Specifies the timeout, in seconds, for fetching the specified measurement. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the function waits until the measurement is complete.
arraySize int32 Specifies the size of the array. Set the arraySize parameter to 0 to get the size of all the arrays in the actualArraySize parameter.
Output
Name Type Description
x0 float64* Returns start time of the signal. This value is expressed in seconds.
dx float64* Returns the time bin spacing. This value is expressed in seconds.
signalPower float32[] Returns the instantaneous signal power trace. This value is expressed in dBm.
absoluteLimit float32[] Returns absolute limit for each segment in the trace as specified by section 6.5.2.4.5 of the 3GPP 36.521 specification.
actualArraySize int32* Returns the actual size of the array, if you pass NULL to all output array parameters, and set the arraySize parameter to 0.

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 condition. Examine the status code from each call to an RFmx 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 RFmxLTE_GetError) function.

The general meaning of the status code is as follows:
Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors
⚠️ **GitHub.com Fallback** ⚠️