Fetches the ModAcc frequency error trace for basic rate (BR) packets.

Syntax

Namespace: NationalInstruments.RFmx.BTMX

public int FetchFrequencyErrorBR(string selectorString, double timeout, out double initialFrequencyErrorMaximum, out double peakFrequencyDriftMaximum, out double peakFrequencyDriftRateMaximum)

Parameters

NameTypeDescription
selectorStringstring

Specifies a selector string comprising of the result name. If you do not specify the result name, the default result instance is used. Example:
""
"result::r1"
You can use the BuildResultString(string) method to build the selector string.

timeoutdouble

Specifies the timeout for fetching the specified measurement. This value is expressed in seconds. Set this value to an appropriate time, longer than expected for fetching the measurement. A value of -1 specifies that the method waits until the measurement is complete.

initialFrequencyErrorMaximumout double

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

peakFrequencyDriftMaximumout double

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

peakFrequencyDriftRateMaximumout double

Upon return, contains the peak frequency drift rate value computed on the BR packet. When you set the ModAcc Averaging Enabled method to SetAveragingEnabled(string, RFmxBTMXModAccAveragingEnabled) method to True, it returns the value corresponding to the maximum of absolute peak frequency drift rate 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.