RFmxDemod_ADemodFetchAMMaximumModulationDepth

RFmx Demod 19.1 Help

Edition Date: October 2019

Part Number: 374641M-01

»View Product Info

Download Help (Windows Only)


RFmx Demod 19.1 Help
RFmx Demod 20.0 Help

int32 __stdcall RFmxDemod_ADemodFetchAMMaximumModulationDepth (niRFmxInstrHandle instrumentHandle, char selectorString[], float64 timeout, float64* maximumModulationDepth, float64* maximumHalfPeakToPeak, float64* maximumRMS, float64* maximumPositivePeak, float64* maximumNegativePeak);

Purpose

Fetches the AM maximum modulation depth.

Parameters

Input
Name Type Description
instrumentHandle niRFmxInstrHandle Specifies the RFmx session. You can obtain this parameter from the RFmxDemod_Initialize function.
selectorString char[]

Comprises the signal name and result name. If you do not specify the signal name, the default signal instance is used.

Example:

""

"signal::sig1"

"result::r1"

"signal::sig1/result::r1"

You can use the RFmxDemod_BuildSignalString function to build the selector string.

timeout float64 specifies the time, in seconds, for which the function waits for the measurement to complete. A value of -1 specifies that the function waits until the measurement is complete.
Output
Name Type Description
maximumModulationDepth float64* Returns the maximum modulation depth, as a percentage, measured across multiple acquisitions.
maximumHalfPeakToPeak float64* Returns the maximum (peak-to-peak)/2 amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.
maximumRMS float64* Returns the maximum RMS amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.
maximumPositivePeak float64* Returns the maximum positive peak amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.
maximumNegativePeak float64* Returns the maximum negative peak amplitude, as a percentage, of the modulating signal measured across multiple acquisitions.

Return Value

Name Type Description
status int32 Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an RFmx function to determine if an error has occurred.

To obtain a text description of the status code and additional information about the error condition, call the RFmxDemod_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

WAS THIS ARTICLE HELPFUL?

Not Helpful