NI RFmx LTE ACP Fetch Functions - ni/grpc-device GitHub Wiki
- RFmxLTE_ACPFetchTotalAggregatedPower
- RFmxLTE_ACPFetchSubblockMeasurement
- RFmxLTE_ACPFetchComponentCarrierMeasurement
- RFmxLTE_ACPFetchComponentCarrierMeasurementArray
- RFmxLTE_ACPFetchOffsetMeasurement
- RFmxLTE_ACPFetchOffsetMeasurementArray
- RFmxLTE_ACPFetchSpectrum
- RFmxLTE_ACPFetchRelativePowersTrace
- RFmxLTE_ACPFetchAbsolutePowersTrace
int32 __stdcall RFmxLTE_ACPFetchTotalAggregatedPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* totalAggregatedPower);
Returns the sum of powers in all the subblocks.
| 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 and the result name. 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: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) 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 |
| totalAggregatedPower | float64* | Returns the sum of powers of all the subblocks. This value includes the power in the inter-carrier gaps within a subblock, but it does not include the power in the subblock gaps. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchSubblockMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* subblockPower, float64* integrationBandwidth, float64* frequency);
Returns the power, integration bandwidth and center frequency of the subblock. Use "subblock<n>" as the selector string to read results from this function.
| 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. |
| Output | ||
| Name | Type | Description |
| subblockPower | float64* | Returns the sum of powers of all the frequency bins over the integration bandwidth of the subblock. |
| integrationBandwidth | float64* | Returns the integration bandwidth used in calculating the power of the subblock. Integration bandwidth is the span from left edge of the leftmost carrier to the right edge of the rightmost carrier within a subblock. |
| frequency | float64* | Returns the absolute center frequency of the subblock. This value is the center of the subblock integration bandwidth. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchComponentCarrierMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* absolutePower, float64* relativePower);
Fetches the ACP component carrier measurement. Use "carrier<k>" or "subblock<n>/carrier<k>" as the selector string to read results from this function.
| 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 |
| absolutePower | float64* | Returns the power measured over the integration bandwidth of the carrier/subblock. |
| relativePower | float64* | Returns the component carrier power relative to its subblock power. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchComponentCarrierMeasurementArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 absolutePower[], float64 relativePower[], int32 arraySize, int32* actualArraySize);
Returns an array of the absolute and relative powers of the component carriers. The relative power is relative to the subblock power. Use "subblock<n>" as the selector string to read results from this function.
| 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 |
| absolutePower | float64[] | Returns the array of powers measured over the integration bandwidths of the component carriers in a subblock. |
| relativePower | float64[] | Returns the array of component carrier powers relative to their subblock powers measured over the integration bandwidths of the component carriers in the subblock. |
| 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. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchOffsetMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* lowerRelativePower, float64* upperRelativePower, float64* lowerAbsolutePower, float64* upperAbsolutePower);
Returns the absolute and relative power of the lower and upper offset channel. The relative power is relative to subblock power. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function. Refer to the LTE Uplink Adjacent Channel Power) and LTE Downlink Adjacent Channel Power topics for more information.
| 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 offset 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/offset0" "signal::sig1/subblock0/offset0" "signal::sig1/result::r1/subblock0/offset0" "result::r1/subblock0/offset0" You can use the RFmxLTE_BuildOffsetString) 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 |
| lowerRelativePower | float64* | Returns the power in lower (negative) offset channel relative to value returned by the RFMXLTE_ATTR_ACP_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of the offset channel, refer to the 3GPP TS 36.521 specification. |
| upperRelativePower | float64* | Returns the power in upper (positive) offset channel relative to the value returned by the RFMXLTE_ATTR_ACP_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of the offset channel, refer to the 3GPP TS 36.521 specification. |
| lowerAbsolutePower | float64* | Returns the lower (negative) offset channel power. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of an offset channel, refer to the 3GPP TS 36.521 specification. |
| upperAbsolutePower | float64* | Returns the upper (positive) offset channel power. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of offset channel, refer 3GPP TS 36.521 specification. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchOffsetMeasurementArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 lowerRelativePower[], float64 upperRelativePower[], float64 lowerAbsolutePower[], float64 upperAbsolutePower[], int32 arraySize, int32* actualArraySize);
Returns an array of absolute and relative powers of the lower and upper offset channels. The relative power is relative to subblock power. The order of the offsets in the result array is universal terrestrial radio access (UTRA) (1, 2, ...m) and evolved universal terrestrial radio access (E-UTRA) (1, ..., n), where m and n are the number of UTRA offsets and the number of EUTRA offsets respectively. Use "subblock<n>" as the selector string to read results from this function. Refer to the LTE Uplink Adjacent Channel Power) and LTE Downlink Adjacent Channel Power topics for more information
| 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 |
| lowerRelativePower | float64[] | Returns the array of power in lower (negative) offset channel relative to the value returned by the RFMXLTE_ATTR_ACP_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of the offset channel, refer to the 3GPP TS 36.521 specification. |
| upperRelativePower | float64[] | Returns the array of powers in upper (positive) offset channel relative to the value returned by the RFMXLTE_ATTR_ACP_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of the offset channel, refer to the 3GPP TS 36.521 specification. |
| lowerAbsolutePower | float64[] | Returns the array of lower (negative) offset channel power. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of offset channel, refer to 3GPP TS 36.521 specification. |
| upperAbsolutePower | float64[] | Returns the array of upper (positive) offset channel powers. For the intra-band noncontiguous type of carrier aggregation, if this offset is not applicable, a NaN is returned. For more information about the applicability of offset channel, refer 3GPP TS 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. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], int32 arraySize, int32* actualArraySize);
Fetches the spectrum used for the ACP measurement.
| 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 and the result name. 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: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) 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 the start frequency of the channel. This value is expressed in Hz. |
| dx | float64* | Returns the frequency bin spacing. This value is expressed in Hz. |
| spectrum | float32[] | Returns the array of averaged power measured at each frequency bin. This value is expressed in dBm. |
| 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. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchRelativePowersTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 traceIndex, float64* x0, float64* dx, float32 relativePowersTrace[], int32 arraySize, int32* actualArraySize);
Fetches the relative powers trace for ACP measurement.
| 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 and the result name. 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: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) 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. |
| traceIndex | int32 | Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets). |
| 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 the start frequency of the channel. This value is expressed in Hz. |
| dx | float64* | Returns the frequency bin spacing. This value is expressed in Hz. |
| relativePowersTrace | float32[] | Returns the trace of relative powers measured relative to total aggregated power in the channel specified by the traceIndex parameter. This value is expressed in dB. |
| 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. |
| 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 |
int32 __stdcall RFmxLTE_ACPFetchAbsolutePowersTrace (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 traceIndex, float64* x0, float64* dx, float32 absolutePowersTrace[], int32 arraySize, int32* actualArraySize);
Fetches the absolute powers trace.
| 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 and the result name. 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: "signal::sig1" "result::r1" "signal::sig1/result::r1" You can use the RFmxLTE_BuildSignalString) 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. |
| traceIndex | int32 | Specifies the index of the trace to fetch. The traceIndex can range from 0 to (Number of carriers + 2*Number of offsets). |
| 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 the start frequency of the channel. This value is expressed in Hz. |
| dx | float64* | Returns the frequency bin spacing. This value is expressed in Hz. |
| absolutePowersTrace | float32[] | Returns the trace of the measured integrated power in the channel specified by the traceIndex parameter. This value is expressed in dBm. |
| 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. |
| 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 |