-
Notifications
You must be signed in to change notification settings - Fork 52
NI RFmx WLAN Fetch SEM Functions
- RFmxWLAN_SEMFetchMeasurementStatus
- RFmxWLAN_SEMFetchCarrierMeasurement
- RFmxWLAN_SEMFetchLowerOffsetMargin
- RFmxWLAN_SEMFetchLowerOffsetPower
- RFmxWLAN_SEMFetchUpperOffsetMargin
- RFmxWLAN_SEMFetchUpperOffsetPower
- RFmxWLAN_SEMFetchLowerOffsetMarginArray
- RFmxWLAN_SEMFetchLowerOffsetPowerArray
- RFmxWLAN_SEMFetchUpperOffsetMarginArray
- RFmxWLAN_SEMFetchUpperOffsetPowerArray
- RFmxWLAN_SEMFetchSpectrum
int32 __stdcall RFmxWLAN_SEMFetchMeasurementStatus (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus);
Fetches the overall measurement status.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name and 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 RFmxWLAN_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 overall measurement status indicating whether the spectrum exceeds the SEM measurement mask limits in any of the offset segments. |
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | The spectrum exceeds the SEM measurement mask limits for at least one of the offset segments. |
---|---|
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | The spectrum does not exceed the SEM measurement mask limits for any offset segment. |
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchCarrierMeasurement (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* absolutePower, float64* relativePower);
Returns the absolute and relative carrier power measurements. The relative power is relative to the peak power of the carrier. Use "segment<n>/chain<k>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, and chain 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: "segment0/chain0" "signal::sig1/segment0/chain0" "signal::sig1/result::r1/segment0/chain0" "result::r1/segment0/chain0" You can use the RFmxWLAN_BuildChainString 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 average power of the carrier channel over the bandwidth indicated by the RFMXWLAN_ATTR_SEM_CARRIER_INTEGRATION_BANDWIDTH attribute. This value is expressed in dBm. |
relativePower | float64* | Returns the average power of the carrier channel, relative to the peak power of the carrier channel, over the bandwidth indicated by the RFMXWLAN_ATTR_SEM_CARRIER_INTEGRATION_BANDWIDTH attribute. This value is expressed in dBm. |
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchLowerOffsetMargin (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus, float64* margin, float64* marginFrequency, float64* marginAbsolutePower, float64* marginRelativePower);
Returns the measurement status, margin, margin-frequency, and absolute and relative power corresponding to the margin-frequency for lower offset segment. The relative power is relative to the peak power in the carrier. Use "segment<n>/chain<k>/offset<l>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, chain number, and offset number. If you do not specify the signal name, the default signal instance is used. Example: "segment0/chain0/offset0" "signal::sig1/segment0/chain0/offset0" "signal::sig1/result::r1/segment0/chain0/offset0" "result::r1/segment0/chain0/offset0" You can use the RFmxWLAN_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 lower offset (negative) segment measurement status, indicating whether the spectrum exceeds the SEM measurement mask limits in the lower offset segment. |
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | The spectrum exceeds the SEM measurement mask limits the lower offset segment. |
---|---|
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | The spectrum does not exceed the SEM measurement mask limits for the lower offset segment. |
margin | float64* | Returns the margin from the SEM measurement mask for the lower offset. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the mask. |
marginFrequency | float64* | Returns the frequency corresponding to the margin for the lower offset. This value is expressed in Hz. |
marginAbsolutePower | float64* | Returns the absolute power corresponding to the margin for the lower offset. This value is expressed in dBm. |
marginRelativePower | float64* | Returns the relative power corresponding to the margin for the lower offset. The relative power is relative to the peak power of the carrier channel. This value is expressed in dB. |
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchLowerOffsetPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* totalAbsolutePower, float64* totalRelativePower, float64* peakAbsolutePower, float64* peakFrequency, float64* peakRelativePower);
Returns the total absolute and relative powers, peak absolute and relative powers and frequency at peak absolute power of lower offset segment. The relative power is relative to the peak power of the carrier. Use "segment<n>/chain<k>/offset<l>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, chain number, and offset number. If you do not specify the signal name, the default signal instance is used. Example: "segment0/chain0/offset0" "signal::sig1/segment0/chain0/offset0" "signal::sig1/result::r1/segment0/chain0/offset0" "result::r1/segment0/chain0/offset0" You can use the RFmxWLAN_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 |
totalAbsolutePower | float64* | Returns the average power of the lower offset over the bandwidth determined by the offset start and stop frequencies. This value is expressed in dBm. |
totalRelativePower | float64* | Returns the average power of the lower offset relative to the peak power of the carrier channel. This value is expressed in dB. |
peakAbsolutePower | float64* | Returns the peak power of the lower offset. This value is expressed in dBm. |
peakFrequency | float64* | Returns the frequency at which the peak power occurs in the lower offset. This value is expressed in Hz. |
peakRelativePower | float64* | Returns the peak power of the lower offset, relative to the peak power of the carrier channel. This value is expressed in dBm. |
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchUpperOffsetMargin (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, int32* measurementStatus, float64* margin, float64* marginFrequency, float64* marginAbsolutePower, float64* marginRelativePower);
Returns the measurement status, margin, margin-frequency, absolute and relative power corresponding to the margin-frequency for upper offset segment. The relative power is relative to the peak power in the carrier. Use "segment<n>/chain<k>/offset<l>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, chain number, and offset number. If you do not specify the signal name, the default signal instance is used. Example: "segment0/chain0/offset0" "signal::sig1/segment0/chain0/offset0" "signal::sig1/result::r1/segment0/chain0/offset0" "result::r1/segment0/chain0/offset0" You can use the RFmxWLAN_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 upper (positive) offset segment measurement status, indicating whether the spectrum exceeds the SEM measurement mask limits in the upper offset segment. |
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | The spectrum exceeds the SEM measurement mask limits the upper offset segment. |
---|---|
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | The spectrum does not exceed the SEM measurement mask limits for the upper offset segment. |
margin | float64* | Returns the margin from the SEM measurement mask for the upper offset. Margin is defined as the maximum difference between the spectrum and the mask. This value is expressed in dB. |
marginFrequency | float64* | Returns the frequency corresponding to the margin for the upper offset. This value is expressed in Hz. |
marginAbsolutePower | float64* | Returns the power level of the spectrum, corresponding to the RFMXWLAN_ATTR_SEM_RESULTS_UPPER_OFFSET_MARGIN result. This value is expressed in dBm. |
marginRelativePower | float64* | Returns the power level of the spectrum, corresponding to the RFMXWLAN_ATTR_SEM_RESULTS_UPPER_OFFSET_MARGIN result. The power level is returned relative to the peak power of the carrier channel. This value is expressed in dB. |
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchUpperOffsetPower (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* totalAbsolutePower, float64* totalRelativePower, float64* peakAbsolutePower, float64* peakFrequency, float64* peakRelativePower);
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 the peak power of the carrier. Use "segment<n>/chain<k>/offset<l>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, chain number, and offset number. If you do not specify the signal name, the default signal instance is used. Example: "segment0/chain0/offset0" "signal::sig1/segment0/chain0/offset0" "signal::sig1/result::r1/segment0/chain0/offset0" "result::r1/segment0/chain0/offset0" You can use the RFmxWLAN_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 |
totalAbsolutePower | float64* | Returns the average power of the upper (positive) offset over the bandwidth determined by the offset start and stop frequencies. This value is expressed in dBm. |
totalRelativePower | float64* | Returns the average power of the upper offset relative to the peak power of the carrier channel. This value is expressed in dB. |
peakAbsolutePower | float64* | Returns the peak power of the upper offset. This value is expressed in dBm. |
peakFrequency | float64* | Returns the frequency at which the peak power occurs in the upper offset. This value is expressed in Hz. |
peakRelativePower | float64* | Returns the peak power of the upper offset, relative to the peak power of the carrier channel. This value is expressed in dBm. |
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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_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 status, margins, margin-frequencies, and absolute and relative powers corresponding to the margin-frequencies for lower offset segments. The relative powers are relative to the peak power in the carrier. Use "segment<n>/chain<k>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, and chain 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: "segment0/chain0" "signal::sig1/segment0/chain0" "signal::sig1/result::r1/segment0/chain0" "result::r1/segment0/chain0" You can use the RFmxWLAN_BuildChainString 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 an array of lower (negative) offset segment measurement status, indicating whether the spectrum exceeds the SEM measurement mask limits in the lower offset segments. |
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | The spectrum exceeds the SEM measurement mask limits the lower offset segment. |
---|---|
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | The spectrum does not exceed the SEM measurement mask limits for the lower offset segment. |
margin | float64[] | Returns an array of margins from the SEM measurement mask for the lower offset. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the mask. |
marginFrequency | float64[] | Returns an array of frequencies corresponding to the margins for the lower (negative) offsets. This value is expressed in dB. |
marginAbsolutePower | float64[] | Returns an array of absolute powers corresponding to the margins for the lower offsets. This value is expressed in dBm. |
marginRelativePower | float64[] | Returns an array of relative powers corresponding to the margins for the lower offsets. The relative powers are relative to the peak power of the carrier channel. 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchLowerOffsetPowerArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 totalAbsolutePower[], float64 totalRelativePower[], float64 peakAbsolutePower[], float64 peakFrequency[], float64 peakRelativePower[], int32 arraySize, int32* actualArraySize);
Returns an array of total absolute and relative powers, peak absolute and relative powers and frequencies corresponding to the peak absolute powers of lower offset segments. The relative powers are relative to peak power of the carrier. Use "segment<n>/chain<k>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, and chain 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: "segment0/chain0" "signal::sig1/segment0/chain0" "signal::sig1/result::r1/segment0/chain0" "result::r1/segment0/chain0" You can use the RFmxWLAN_BuildChainString 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 |
totalAbsolutePower | float64[] | Returns an array of average powers of the lower offsets over the bandwidth determined by the offset start and stop frequencies. This value is expressed in dBm. |
totalRelativePower | float64[] | Returns an array of average powers of the lower offsets relative to the peak power of the carrier channel. This value is expressed in dB. |
peakAbsolutePower | float64[] | Returns an array of peak powers of the lower offsets. This value is expressed in dBm. |
peakFrequency | float64[] | Returns an array of frequencies at which the peak power occurs in the lower offsets. This value is expressed in Hz. |
peakRelativePower | float64[] | Returns an array of peak powers of the lower offsets, relative to the peak power of the carrier channel. 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_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 status, margins, margin frequencies, absolute and relative powers corresponding to the margin-frequencies for upper offset segments. The relative powers are relative to the peak power in the carrier. Use "segment<n>/chain<k>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, and chain 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: "segment0/chain0" "signal::sig1/segment0/chain0" "signal::sig1/result::r1/segment0/chain0" "result::r1/segment0/chain0" You can use the RFmxWLAN_BuildChainString 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 an array of upper offset (positive) segment measurement status, indicating whether the spectrum exceeds the SEM measurement mask limits in the upper offset segments. |
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_FAIL (0) | The spectrum exceeds the SEM measurement mask limits the upper offset segment. |
---|---|
RFMXWLAN_VAL_SEM_MEASUREMENT_STATUS_PASS (1) | The spectrum does not exceed the SEM measurement mask limits for the upper offset segment. |
margin | float64[] | Returns an array of margins from the SEM measurement mask for the upper offset. This value is expressed in dB. Margin is defined as the maximum difference between the spectrum and the mask. |
marginFrequency | float64[] | Returns an array of frequencies corresponding to the margins for the upper offsets. This value is expressed in Hz. |
marginAbsolutePower | float64[] | Returns an array of absolute powers corresponding to the margins for the upper (positive) offsets. This value is expressed in dBm. |
marginRelativePower | float64[] | Returns an array of relative powers corresponding to the margins for the upper (positive) offsets. The relative powers are relative to the peak power of the carrier channel. 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchUpperOffsetPowerArray (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64 totalAbsolutePower[], float64 totalRelativePower[], float64 peakAbsolutePower[], float64 peakFrequency[], float64 peakRelativePower[], int32 arraySize, int32* actualArraySize);
Fetches an array of total absolute and relative powers, peak absolute and relative powers, and frequencies corresponding to the peak absolute powers of upper offset segments. The relative powers are relative to peak power of the carrier. Use "segment<n>/chain<k>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, and chain 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: "segment0/chain0" "signal::sig1/segment0/chain0" "signal::sig1/result::r1/segment0/chain0" "result::r1/segment0/chain0" You can use the RFmxWLAN_BuildChainString 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 |
totalAbsolutePower | float64[] | Returns an array of average powers of the upper offsets over the bandwidth determined by the offset start and stop frequencies. This value is expressed in dBm. |
totalRelativePower | float64[] | Returns an array of average powers of the upper offsets relative to the peak power of the carrier channel. This value is expressed in dB. |
peakAbsolutePower | float64[] | Returns an array of peak powers of the upper offsets. This value is expressed in dBm. |
peakFrequency | float64[] | Returns an array of frequencies at which the peak power occurs in the upper offsets. This value is expressed in Hz. |
peakRelativePower | float64[] | Returns an array of peak powers of the upper offsets, relative to the peak power of the carrier channel. 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
int32 __stdcall RFmxWLAN_SEMFetchSpectrum (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* x0, float64* dx, float32 spectrum[], float32 compositeMask[], int32 arraySize, int32* actualArraySize);
Fetches the spectrum and mask traces. Use "segment<n>/chain<k>" as the selector string to read results from this function.
Input | ||
---|---|---|
Name | Type | Description |
instrumentHandle | niRFmxInstrHandle | Specifies the instrument session. The RFmx driver obtains this parameter from the RFmxWLAN_Initialize function. |
selectorString | char[] | Specifies a selector string comprising of the signal name, result name, segment number, and chain 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: "segment0/chain0" "signal::sig1/segment0/chain0" "signal::sig1/result::r1/segment0/chain0" "result::r1/segment0/chain0" You can use the RFmxWLAN_BuildChainString 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. This value is expressed in Hz. |
dx | float64* | Returns the frequency bin spacing. This value is expressed in Hz. |
spectrum | float32[] | Returns an array of power measured at each frequency bin. This value is expressed in dBm. |
compositeMask | float32[] | Returns an array of mask level values for 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 RFmxWLAN_GetError function. The general meaning of the status code is as follows: |
Value | Meaning |
---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |
Creating and Setting Up a gRPC Server
Session Utilities API Reference
gRPC API Differences From C API
Sharing Driver Sessions Between Clients
C API Docs
NI-DAQmx
- gRPC API Differences From C API
- Task Configuration And Control
- Channel Configuration And Creation
- Timing
- Triggering
- Read Functions
- Write Functions
- Export Hardware Signals
- Scale Configuration
- Internal Buffer Configuration
- Advanced Functions
- System Configuration
- Error Handling
- Buffer Attributes
- Calibration Info Attributes
- Channel Attributes
- Device Attributes
- Export Signal Attributes
- Persisted Channel Attributes
- Persisted Scale Attributes
- Persisted Task Attributes
- Physical Channel Attributes
- Read Attributes
- Scale Attributes
- System Attributes
- Task Attributes
- Timing Attributes
- Trigger Attributes
- Watchdog Attributes
- Write Attributes
NI-DCPOWER
- Setup Functions
- Configure Functions
- Measurement Functions
- Control Functions
- Trigger And Event
- Attribute Functions
- Query Functions
- Calibration Functions
- Utility Functions
- Supported Device
- Source Attributes
- Transient Attributes
- Voltage Attributes
- Current Attributes
- Pulse Voltage Attributes
- Pulse Current Attributes
- Cutoff Attributes
- Measurement Attributes
- Trigger Attributes Functions
- Event Attributes
- Advanced Attributes
- Inherent Ivi Attributes
- Supported Device Attributes
NI-DIGITAL PATTERN DRIVER
- Init And Close Functions
- Session Locking Functions
- Utility Functions
- Error Handling Functions
- Calibration Functions
- Attributes Functions
- Pin Map Functions
- Low Level Functions
- Low Level Action Functions
- Pin Control Functions
- Static IO Functions
- Clock Generator Functions
- Levels And Timing Functions
- TDR Functions
- PPMU Configuration Functions
- DC Voltage Functions
- DC Current Functions
- PPMU Action Functions
- Pattern Configuration Functions
- Pattern Action Functions
- History Ram Functions
- Source Memory Functions
- Capture Memory Functions
- Triggers And Events Functions
- Conditional Jump Trigger Functions
- Sequencer Flag Functions
- Sequencer Register Functions
- Match Fail Combination Functions
- Pattern Results Functions
- Sort Results Functions
- Frequency Measurement Functions
- IVI Inherent Attributes
- Specific Driver Information Attributes, Read Only
- Driver Setup Information Attributes
- Device Attributes
- Pin Control Attributes
- Level Configuration Attributes
- Trigger Configuration Attributes
- PPMU Attributes
- Patterns Attributes
- Pattern Opcode Event Attributes
- Timing Offset Attributes
- Keep Alive Attributes
- Frequency Measurement Attributes
- Clock Generator Attributes
- History RAM
- Synchronization Attributes
- TDR Endpoint Termination Attributes
NI-FGEN
- Setup Functions
- Configuration Functions
- Standard Output Functions
- Arbitrary Waveform Output Functions
- Arbitrary Sequence Output Functions
- Incremental Waveform Write Functions
- Configure Clock Functions
- Trigger And Syncronizations Functions
- 5404 Routing Functions
- Script Output Functions
- Configure Onboard Signal Processing Functions
- Configure Peer To Peer Functions
- Attribute Functions
- Waveform Control Functions
- Error Functions
- Output Attributes
- Arbitrary Waveform Attributes
- Data Transfer Attributes
- Onboard Signal Processing Attributes
- Peer To Peer Attributes
- Standard Function Attributes
- Clock Attributes
- Event Attributes
- Triggering Attributes
- Instrument Specific Attributes
- Inherent IVI Attributes
- 5401 5411 5431
NI-RFmx Bluetooth
- gRPC API Differences From C API
- General Functions
- Configuration Functions
- Set And Get Attribute Functions
- Fetch Results Functions
- Utility Functions
- Build String Functions
- Advanced Functions
- General Attributes
- Trigger Attributes
- Packet Attributes
- Auto Detect Signal Attributes
- Modacc Attributes
- ACP Attributes
- Twenty dB Attributes
- Frequency Range Attributes
- TXP Attributes
- Advanced Attributes
NI-RFmx NR
- gRPC API Differences From C API
- General Functions
- Configuration Functions
- Set And Get Attributes Functions
- Fetch Results Functions
- Utility Functions
- Build String Functions
- Advanced Functions
- General Attributes
- Trigger Attributes
- Signal Detection Attributes
- Component Carrier Attributes
- List Attributes
- Modacc Attributes
- ACP Attributes
- CHP Attributes
- OBW Attributes
- SEM Attributes
- TXP Attributes
- Pvt Attributes
- Advanced Attributes
NI-RFmx LTE
- gRPC API Differences From C API
- General Functions
- Configuration Functions
- Ch Configuration Functions
- NB IoT Configuration Functions
- ModAcc Configuration Functions
- ACP Configuration Functions
- CHP Configuration Functions
- OBW Configuration Functions
- SEM Configuration Functions
- PVT Configuration Functions
- SlotPhase Configuration Functions
- SlotPower Configuration Functions
- Set And Get Attribute Functions
- ModAcc Fetch Functions
- ACP Fetch Functions
- CHP Fetch Functions
- OBW Fetch Functions
- SEM Fetch Functions
- PVT Fetch Functions
- SlotPhase Fetch Functions
- SlotPower Fetch Functions
- Utility Functions
- Build String Functions
- Advanced Functions
- General Attributes
- Trigger Attributes
- Component Carrier Attributes
- ModAcc Attributes
- ACP Attributes
- CHP Attributes
- OBW Attributes
- SEM Attributes
- PVT Attributes
- SlotPhase Attributes
- SlotPower Attributes
- Advanced Attributes
NI-RFmx SpecAn
- gRPC API Differences From C API
- General Functions
- Configuration Functions
- Set And Get Attribute Functions
- Read Functions
- Fetch Functions
- Utility Functions
- Marker Functions
- Build String Functions
- Advanced Functions
- General Attributes
- Trigger Attributes
- ACP Attributes
- Cdf Attributes
- CHP Attributes
- Fcnt Attributes
- Harm Attributes
- OBW Attributes
- SEM Attributes
- Spectrum Attributes
- Spur Attributes
- TXP Attributes
- AMPM Attributes
- Dpd Attributes
- IQ Attributes
- IM Attributes
- NF Attributes
- Phasenoise Attributes
- PAVT Attributes
- Advanced Attributes
NI-RFmx WLAN
- gRPC API Differences From C API
- General Functions
- Configuration Functions
- Set And Get Attribute Functions
- Fetch DSSS ModAcc Functions
- Fetch OFDM ModAcc Functions
- Fetch SEM Functions
- Fetch TXP Functions
- Fetch PowerRamp Functions
- Utility Functions
- Build String Functions
- Advanced Functions
- General Attributes
- Trigger Attributes
- OFDM Attributes
- Auto Detect Signal Attributes
- DSSS ModAcc Attributes
- OFDM ModAcc Attributes
- SEM Attributes
- TXP Attributes
- PowerRamp Attributes
- Advanced Attributes
NI-RFSA
- General Functions
- Configuration Functions
- Acquisition Functions
- Utility Functions
- Calibration Functions
- General Attributes
- Vertical Attributes
- Signal Path Attributes
- Acquisition Attributes
- Acquisition Attributes
- Triggers Attributes
- Events Attributes
- Device Characteristics Attributes
- Peer To Peer Streaming Attributes
- Configuration List Attributes
- Inherent IVI Properties Attributes
- De-embedding Attributes
- Self Calibration Attributes
- Factory Calibration Attributes
- External Alignment Attributes
- Device Specific Attributes
NI-RFSG
- General Functions
- Generation Configuration
- Utility Functions
- Calibration Functions
- Arb Attributes
- Clock Attributes
- Configuration List Attributes
- De-embedding Attributes
- Device Characteristics Attributes
- Device Specific Attributes
- Events Attributes
- External Calibration Attributes
- Inherent IVI Attributes Attributes
- IQ Impairment Attributes
- Load Configurations Attributes
- Modulation Attributes
- Obsolete Attributes
- Peer To Peer Attributes
- RF Attributes
- Self Calibration Attributes
- Triggers Attributes
NI-SCOPE
- Setup Functions
- Configure Functions
- Attribute Functions
- Acquisition Functions
- Measurement Functions
- Calibrate Functions
- Utility Funcitons
- Error Handling Functions
- IVI Compliance Or Obsolete Functions
- Vertical Attributes
- Horizontal Attributes
- Trigger Attributes
- Clocking Attributes
- Synchronization Attributes
- Acquisition Attributes
- Waveform Measurements Attributes
- Onboard Signal Processing Attributes
- Peer To Peer Streaming Attributes
- Device Attributes
- IVI Or Obsolete Attributes
- Instrument Capabilities Attributes
- If Digitizer Attributes
NI-XNET
- gRPC API differences from C APIs
- General Functions
- Cluster Properties
- Database Properties
- Device Properties
- ECU Properties
- Frame Properties
- Interface Properties
- LIN Schedule Entry Properties
- LIN Schedule Properties
- PDU Properties
- Session Ethernet Properties
- Session Frame Properties
- Session Interface Properties
- Session Properties
- Session SAE J1939 Properties
- Signal Properties
- Subframe Properties
- System Properties
- IP-Stack Functions
- Socket Options
- Socket Functions