RFmx SpecAn DOTNET

RFmxSpecAnMXSemResults.FetchUpperOffsetMarginArray Method

  • Updated2024-07-17
  • 2 minute(s) read
RFmxSpecAnMXSemResults.FetchUpperOffsetMarginArray Method

RFmxSpecAnMXSemResultsFetchUpperOffsetMarginArray Method

Fetches the measurement status and margin from the limit line measured in the upper offset segments.

Namespace: NationalInstruments.RFmx.SpecAnMX
Assembly: NationalInstruments.RFmx.SpecAnMX.Fx40 (in NationalInstruments.RFmx.SpecAnMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)

Syntax

public int FetchUpperOffsetMarginArray(
	string selectorString,
	double timeout,
	ref RFmxSpecAnMXSemUpperOffsetMeasurementStatus[] measurementStatus,
	ref double[] margin,
	ref double[] marginFrequency,
	ref double[] marginAbsolutePower,
	ref double[] marginRelativePower
)
Public Function FetchUpperOffsetMarginArray ( 
	selectorString As String,
	timeout As Double,
	ByRef measurementStatus As RFmxSpecAnMXSemUpperOffsetMeasurementStatus(),
	ByRef margin As Double(),
	ByRef marginFrequency As Double(),
	ByRef marginAbsolutePower As Double(),
	ByRef marginRelativePower As Double()
) As Integer

Parameters

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  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  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  Double
Upon return, contains the array of frequencies, in hertz (Hz), at which the margin occurred in each upper (positive) offset.
marginAbsolutePower  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  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.

Return Value

Int32
Returns the status code of this method. The status code either indicates success or describes an error or warning condition.

Remarks

This method maps to the RFmxSpecAn_SEMFetchUpperOffsetMarginArray() function in C.

See Also