NI RFmx WLAN Fetch SEM Functions - ni/grpc-device GitHub Wiki
- 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 |