Gets the initial frequency error value computed on the preamble portion of the BR packet. When you set the SetAveragingEnabled(string, RFmxBTMXModAccAveragingEnabled) method to True, it returns the value corresponding to the maximum of the absolute initial frequency error values computed for each averaging count. This value is expressed in Hz.

Syntax

Namespace: NationalInstruments.RFmx.BTMX

public int GetBRInitialFrequencyErrorMaximum(string selectorString, out double value)

Remarks

This method gets the value of ModAccResultsBRInitialFrequencyErrorMaximum attribute.

Parameters

NameTypeDescription
selectorStringstring

Specifies the result name.
Example: ""
"result::r1"
You can use the BuildResultString(string) method to build the selectorString.

valueout double

Upon return, contains the initial frequency error value computed on the preamble portion of the BR packet. When you set the SetAveragingEnabled(string, RFmxBTMXModAccAveragingEnabled) method to True, it returns the value corresponding to the maximum of the absolute initial frequency error values computed for each averaging count. This value is expressed in Hz.

Returns

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