GtWaveGetOffset

Supported By

GX1110, GX1120

Applies To

Function Generator and Arbitrary Waveform Generator modes.

Purpose

Returns the programmed output offset voltage.

Syntax

GtWaveGetOffset (nHandle, nChannel, pdOffset, 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.
pdOffset
PDOUBLE
GX1120:
Output offset voltage ranges from -4.0V to +4.0V.
The output level may be programmed from 0.1V to 8V p-p into 50 Ohm (0.2V to 16V p-p into an open circuit).
GX1120:
Output offset voltage ranges from -5.0V to +5.0V.
The output level may be programmed from 0.01V to 10V p-p into 50 Ohm (0.2V to 20V p-p into an 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 +/- 4V (GX1120) and +/- 5V (GX1120).

See the specification section for more details.

Example

The following example Returns the output offset voltage:

 

DOUBLE dOffset;

GtWaveGetOffset (nHandle, GTWAVE_CHANNEL_A, &dOffset, &nStatus);

 

See Also

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