FetchUpperOffsetMarginArray(string, double, ref RFmxSpecAnMXSemUpperOffsetMeasurementStatus[], ref double[], ref double[], ref double[], ref double[])
- Updated2025-10-13
- 2 minute(s) read
Fetches the measurement status and margin from the limit line measured in the upper offset segments.
Syntax
Namespace: NationalInstruments.RFmx.SpecAnMX
public int FetchUpperOffsetMarginArray(string selectorString, double timeout, ref RFmxSpecAnMXSemUpperOffsetMeasurementStatus[] measurementStatus, ref double[] margin, ref double[] marginFrequency, ref double[] marginAbsolutePower, ref double[] marginRelativePower)
Remarks
This method maps to the RFmxSpecAn_SEMFetchUpperOffsetMarginArray() function in C.
Parameters
| Name | Type | Description |
|---|---|---|
| selectorString | string | Specifies the result name. Example: "", "result::r1". You can use the BuildResultString(string) method to build the selector string. |
| timeout | double | 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 methods waits until the measurement is complete. |
| measurementStatus | ref RFmxSpecAnMXSemUpperOffsetMeasurementStatus[] | Upon return, contains the array of upper offset measurement statuses based on measurement limits and the fail criteria that you specify in the SetOffsetLimitFailMask(string, RFmxSpecAnMXSemOffsetLimitFailMask) method. |
| margin | ref double[] | Upon return, contains the array of margins, in dB, from the limit mask value that you set in the SetOffsetLimitFailMask(string, RFmxSpecAnMXSemOffsetLimitFailMask) method. Margin is defined as the maximum difference between the spectrum and the limit mask. |
| marginFrequency | ref double[] | Upon return, contains the array of frequencies, in hertz (Hz), at which the margin occurred in each upper (positive) offset. |
| marginAbsolutePower | ref double[] | Upon return, contains the array of powers, in dBm or dBm/Hz, at which the margin occurred in each upper (positive) offset segment. The power is measured in dBm when you set the SetPowerUnits(string, RFmxSpecAnMXSemPowerUnits) method to dBm, and in dBm/Hz when you set the SetPowerUnits(string, RFmxSpecAnMXSemPowerUnits) method to dBmPerHertz. |
| marginRelativePower | ref double[] | Upon return, contains the array of powers, in dB, at which the margin occurred in each upper (positive) offset segment relative to the integrated or peak power of the reference carrier. |
Returns
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.