GtWaveFuncGetFmDeviation

Supported By

GX1120

Applies To

Function Generator mode only.

Purpose

Returns the FM deviation frequency.

Syntax

GtWaveFuncGetFmDeviation (nHandle, nChannel, pdDeviation, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX11X0 board.
nChannel
SHORT
Specified Channel number.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
1 = GTWAVE_CHANNEL_B: Channel B.
pdDeviation
PDOUBLE
GX1120:
FM deviation frequency range is 0Hz to 2MHz
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

When FM source is set to internal then the FM deviation frequency range is 0Hz to 2MHz. When FM source is set to external then the deviation frequency will be 100% at the maximum external modulation signal with range of -5V to +5V. The deviation will increase linearly as a percentage of the max value. E.g. an external signal with peak voltage of 2.5V and deviation value of 1KHz will result in actual deviation of 500Hz (50% of peak input voltage range of 5V).

Example

The following example returns the FM deviation frequency:

 

DOUBLE dDeviation;

GtWaveFuncGetFmDeviation (nHandle, GTWAVE_CHANNEL_A, &dDeviation, &nStatus);

 

See Also

GtWaveFuncSetFmDeviation, GtWaveFuncSetFmFrequency, GtWaveFuncSetFmSource, GtWaveFuncSetFmState,  GtWaveFuncSetFmWaveform, GtWaveGetErrorString