GtWaveGetAmplitude

Supported By

GX1110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Returns the waveform’s programmed peak-to-peak amplitude voltage.

Syntax

GtWaveGetAmplitude (nHandle, nChannel, pdAmplitude, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX11X0 board.
nChannel
SHORT
Specified Channel number.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
GX1120:
0 = GTWAVE_CHANNEL_A: Channel A.
1 = GTWAVE_CHANNEL_B: Channel B.
pdAmplitude
PDOUBLE
Waveform peak-to-peak amplitude voltage
GX1120:
0.1V to 8V (p-p) into 50 Ohm
0.2V to 16V (p-p) into open circuit.
GX1120:
0.01V to 10V (p-p) into 50 Ohm
0.02V to 20V (p-p) into open circuit.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Offset may be applied to the output to shift the signal either positive or negative. Offset and amplitude are inter-related, i.e. the maximum positive or negative peak voltage at any time cannot be more then +/-  5V.

4V (GX1120) and +/- 5V (GX1120).

See the specification section for more details.

Example

The following example returns the waveform peak-to-peak amplitude voltage:

 

DOUBLE dAmplitude;

GtWaveGetAmplitude (nHandle, GTWAVE_CHANNEL_A, &dAmplitude, &nStatus);

 

See Also

GtWaveRun, GtWaveStop, GtWaveTrig,GtWaveGetStatusRegiste, GtWaveSetAmplitude, GtWaveSetFilterMode, GtWaveSetOffset, GtWaveSetOperationMode, GtWaveSetOutputState, GtWaveSetReferenceClockSource, GtWaveSetVoltageRangeMode, GtWaveGetErrorString