RFmxDemodMXADemodResults.FetchFMMaximumDeviation Method
- Updated2024-07-17
- 2 minute(s) read
RFmx
Fetches the frequency-modulated (FM) maximum deviation measurements.
Namespace: NationalInstruments.RFmx.DemodMX
Assembly: NationalInstruments.RFmx.DemodMX.Fx40 (in NationalInstruments.RFmx.DemodMX.Fx40.dll) Version: 24.5.0.49286 (24.5.0.49286)
Syntax
public int FetchFMMaximumDeviation( string selectorString, double timeout, out double maximumDeviation, out double maximumHalfPeakToPeak, out double maximumRms, out double maximumPositivePeak, out double maximumNegativePeak )
Public Function FetchFMMaximumDeviation ( selectorString As String, timeout As Double, <OutAttribute> ByRef maximumDeviation As Double, <OutAttribute> ByRef maximumHalfPeakToPeak As Double, <OutAttribute> ByRef maximumRms As Double, <OutAttribute> ByRef maximumPositivePeak As Double, <OutAttribute> ByRef maximumNegativePeak As Double ) As Integer
Parameters
- selectorString String
- Specifies the result name. Example: "", "result::r1". You can use the BuildResultString(String) method to build the selectorString.
- timeout Double
- Specifies the time, in seconds, for which the method waits for the measurement to complete. A value of -1 specifies that the method waits until the measurement is complete.
- maximumDeviation Double
- Upon return, contains the maximum frequency deviation, in hertz (Hz), of the FM signal measured across multiple acquisitions.
- maximumHalfPeakToPeak Double
- Upon return, contains the maximum (peak-to-peak)/2 frequency variation, in Hz, around the nominal frequency of the FM carrier measured across multiple acquisitions.
- maximumRms Double
- Upon return, contains the maximum RMS frequency deviation, in Hz, of the FM signal measured across multiple acquisitions.
- maximumPositivePeak Double
- Upon return, contains the maximum positive peak frequency deviation, in Hz, of the FM signal measured across multiple acquisitions.
- maximumNegativePeak Double
- Upon return, contains the maximum negative peak frequency deviation, in Hz, of the FM signal measured across multiple acquisitions.
Return Value
Int32Returns the status code of this method. The status code either indicates success or describes a warning condition.
Remarks
This method maps to the RFmxDemod_ADemodFetchFMMaximumDeviation() function in C.