NI RFmx LTE SEM Fetch Functions - ni/grpc-device GitHub Wiki
- RFmxLTE_SEMFetchTotalAggregatedPower
- RFmxLTE_SEMFetchMeasurementStatus
- RFmxLTE_SEMFetchSubblockMeasurement
- RFmxLTE_SEMFetchComponentCarrierMeasurement
- RFmxLTE_SEMFetchLowerOffsetMargin
- RFmxLTE_SEMFetchLowerOffsetPower
- RFmxLTE_SEMFetchUpperOffsetMargin
- RFmxLTE_SEMFetchUpperOffsetPower
- RFmxLTE_SEMFetchComponentCarrierMeasurementArray
- RFmxLTE_SEMFetchLowerOffsetMarginArray
- RFmxLTE_SEMFetchLowerOffsetPowerArray
- RFmxLTE_SEMFetchUpperOffsetMarginArray
- RFmxLTE_SEMFetchUpperOffsetPowerArray
- RFmxLTE_SEMFetchSpectrum
int32 __stdcall RFmxLTE_SEMFetchTotalAggregatedPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* totalAggregatedPower);
Returns the sum of powers of all 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_SEMFetchMeasurementStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus);
Returns the overall measurement status based on the standard mask type that you configure.
| 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 |
| measurementStatus | int32* | Returns the measurement status indicating whether the power before and after the burst is within the standard defined limit. |
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | Indicates that the measurement has failed. |
|---|---|
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | Indicates that the measurement has passed. |
| 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_SEMFetchSubblockMeasurement (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 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_SEMFetchComponentCarrierMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* absoluteIntegratedPower, float64* relativeIntegratedPower);
Returns the absolute power and relative power measured in the component carrier. The relative power is relative to subblock power. 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 |
| absoluteIntegratedPower | float64* | Returns the power measured over the integration bandwidth of the carrier. |
| relativeIntegratedPower | 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_SEMFetchLowerOffsetMargin (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus, float64* margin, float64* marginFrequency, float64* marginAbsolutePower, float64* marginRelativePower);
Returns the measurement status, margin, frequency at margin, and the absolute and relative powers at the margin for lower offset segments. The relative power is relative to the total aggregated power. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| measurementStatus | int32* | Returns the measurement status indicating whether the power before and after the burst is within the standard defined limit. |
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | Indicates that the measurement has failed. |
|---|---|
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | Indicates that the measurement has passed. |
| margin | float64* | Returns the margin from the standard-defined absolute limit mask for the lower (negative) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginFrequency | float64* | Returns the frequency at which the margin occurs in the lower (negative) offset. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginAbsolutePower | float64* | Returns the power at which the margin occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginRelativePower | float64* | Returns the power at which the margin occurs in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchLowerOffsetPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* absoluteIntegratedPower, float64* relativeIntegratedPower, float64* absolutePeakPower, float64* peakFrequency, float64* relativePeakPower);
Returns the total absolute and relative powers, peak, absolute, and relative powers, and the frequency at the peak absolute power of the lower offset segment. The relative power is relative to the total aggregated power. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| absoluteIntegratedPower | float64* | Returns the lower (negative) offset segment power. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativeIntegratedPower | float64* | Returns the power in the lower (negative) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| absolutePeakPower | float64* | Returns the peak power in the lower (negative) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| peakFrequency | float64* | Returns the frequency at which the peak power occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativePeakPower | float64* | Returns the peak power in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchUpperOffsetMargin (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus, float64* margin, float64* marginFrequency, float64* marginAbsolutePower, float64* marginRelativePower);
Returns the measurement status, margin, frequency at margin, and absolute and relative powers at margin for upper offset segments. The relative power is relative to total aggregated power. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| measurementStatus | int32* | Returns the measurement status indicating whether the power before and after the burst is within the standard defined limit. |
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | Indicates that the measurement has failed. |
|---|---|
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | Indicates that the measurement has passed. |
| margin | float64* | Returns the margin from the standard defined absolute limit mask for upper offset. Margin is defined as the minimum difference between the spectrum and the limit mask. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginFrequency | float64* | Returns the frequency at which the margin occurs in the upper offset. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginAbsolutePower | float64* | Returns the power at which the margin occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginRelativePower | float64* | Returns the power at which the margin occurs in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchUpperOffsetPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* absoluteIntegratedPower, float64* relativeIntegratedPower, float64* absolutePeakPower, float64* peakFrequency, float64* relativePeakPower);
Returns the total absolute and relative powers, peak, absolute, and relative powers, and frequency at peak absolute power of upper offset segment. The relative power is relative to total aggregated power. Use "offset<n>" or "subblock<n>/offset<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| absoluteIntegratedPower | float64* | Returns the upper offset segment power. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativeIntegratedPower | float64* | Returns the power in the upper offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| absolutePeakPower | float64* | Returns the peak power in the upper offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| peakFrequency | float64* | Returns the frequency at which the peak power occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativePeakPower | float64* | Returns the peak power in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchComponentCarrierMeasurementArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 absoluteIntegratedPower[], float64 relativeIntegratedPower[], int32 arraySize, int32* actualArraySize);
Returns an array of the absolute powers and relative powers measured in the component carriers. The relative power is relative to 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 |
| absoluteIntegratedPower | float64[] | Returns the array of power measured in the subblock. |
| relativeIntegratedPower | float64[] | Returns the array of the sum of powers of all the frequency bins over the integration bandwidth of the component carrier power relative to its subblock power. |
| 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_SEMFetchLowerOffsetMarginArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 measurementStatus[], float64 margin[], float64 marginFrequency[], float64 marginAbsolutePower[], float64 marginRelativePower[], int32 arraySize, int32* actualArraySize);
Returns an array of measurement statuses, margins, frequencies at margins, and absolute and relative powers at margins for lower offset segments. The relative power is relative to the total aggregated power. Use "subblock<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| measurementStatus | int32[] | Returns the array of the measurement status indicating whether the power before and after the burst is within the standard defined limit. |
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | Indicates that the measurement has failed. |
|---|---|
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | Indicates that the measurement has passed. |
| margin | float64[] | Returns the array of margins from the standard-defined absolute limit mask for the lower (negative) offset. Margin is defined as the minimum difference between the spectrum and the limit mask. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginFrequency | float64[] | Returns the array of frequency at which the margin occurs in the lower (negative) offset. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginAbsolutePower | float64[] | Returns the array of power at which the margin occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginRelativePower | float64[] | Returns the array of powers at which the margin occurs in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchLowerOffsetPowerArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 absoluteIntegratedPower[], float64 relativeIntegratedPower[], float64 absolutePeakPower[], float64 peakFrequency[], float64 relativePeakPower[], int32 arraySize, int32* actualArraySize);
Returns an array of total absolute and relative powers, peak, absolute, and relative powers, and frequencies at peak absolute powers of lower offset segments. The relative power is relative to total aggregated power. Use "subblock<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| absoluteIntegratedPower | float64[] | Returns the array of lower (negative) offset segment powers. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativeIntegratedPower | float64[] | Returns the array of powers in the lower (negative) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| absolutePeakPower | float64[] | Returns the array of peak powers in the lower (negative) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| peakFrequency | float64[] | Returns the array of frequency at which the peak power occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativePeakPower | float64[] | Returns the array of peak power in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchUpperOffsetMarginArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32 measurementStatus[], float64 margin[], float64 marginFrequency[], float64 marginAbsolutePower[], float64 marginRelativePower[], int32 arraySize, int32* actualArraySize);
Returns an array of measurement statuses, margins, frequencies at margins, and absolute and relative powers at margins for upper offset segments. The relative power is relative to total aggregated power. Use "subblock<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| measurementStatus | int32[] | Returns the array of the measurement status indicating whether the power before and after the burst is within the standard defined limit. |
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | Indicates that the measurement has failed. |
|---|---|
| RFMXLTE_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | Indicates that the measurement has passed. |
| margin | float64[] | Returns the array of margins from the standard defined absolute limit mask for upper offset. The margin is defined as the minimum difference between the spectrum and the limit mask. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginFrequency | float64[] | Returns the array of frequency at which the margin occurs in the upper offset. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginAbsolutePower | float64[] | Returns the array of power at which the margin occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated, the SEM results lower offset start frequency and SEM results lower offset stop frequency are updated, and the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| marginRelativePower | float64[] | Returns the array of powers at which the margin occurs in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchUpperOffsetPowerArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 absoluteIntegratedPower[], float64 relativeIntegratedPower[], float64 absolutePeakPower[], float64 peakFrequency[], float64 relativePeakPower[], int32 arraySize, int32* actualArraySize);
Returns an array of total absolute and relative powers, peak, absolute, and relative powers, and frequencies at peak absolute powers of upper offset segments. The relative power is relative to total aggregated power. Use "subblock<n>" as the selector string to read results from this function. Refer to the LTE Uplink Spectral Emission Mask) and LTE Downlink Spectral Emission Mask 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 |
| absoluteIntegratedPower | float64[] | Returns the array of upper offset segment powers. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativeIntegratedPower | float64[] | Returns the array of powers in the upper offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER) attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| absolutePeakPower | float64[] | Returns the array of peak powers in the upper offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| peakFrequency | float64[] | Returns the array of frequency at which the peak power occurs in the upper (positive) offset segment. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| relativePeakPower | float64[] | Returns the array of peak power in the upper (positive) offset segment relative to the value returned by the RFMXLTE_ATTR_SEM_RESULTS_TOTAL_AGGREGATED_POWER attribute. For the intra-band noncontiguous type of carrier aggregation, the offset segment may be truncated or discarded based on offset overlap rules as defined in the 3GPP TS 36.521 specification. If the offset segment is truncated the measurement is performed on the updated offset segment. If the offset segment is discarded, a NaN is returned. |
| 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_SEMFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], float32 compositeMask[], int32 arraySize, int32* actualArraySize);
Fetches the spectrum used for the SEM 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. |
| compositeMask | float32[] | Returns the array of composite mask used for the channel. |
| 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 |