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

Syntax

Namespace: NationalInstruments.RFmx.BTMX

public int GetPayloadFrequencyErrorW1Maximum(string selectorString, out double value)

Remarks

This method gets the value of ModAccResultsPayloadFrequencyErrorW1Maximum 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 frequency error value computed on the payload portion of the LE-HDT packet. When you set the SetAveragingEnabled(string, RFmxBTMXModAccAveragingEnabled) method to True, it returns a value corresponding to the maximum of the absolute payload 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.