GxAoStandardWaveformGetConfiguration

Purpose

Gets the waveform configuration for a specified channel.

Applied To

GX1632e

Syntax

GxAoStandardWaveformGetConfiguration (nHandle, nGroup, nChannel, pnWaveformType, pdAmplitude, pdOffset, pdFrequency, pdStartPhase, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX1632e board.
nGroup
SHORT
Group number:
0.      GXAO_GROUPA
1.      GXAO_GROUPB
2.      GXAO_GROUPC
3.    GXAO_GROUPD
nChannel
SHORT
Channel number:
0.      GXAO_CHANNEL_0
1.      GXAO_CHANNEL_1
2.      GXAO_CHANNEL_2
3.      GXAO_CHANNEL_3
4.      GXAO_CHANNEL_4
5.      GXAO_CHANNEL_5
6.      GXAO_CHANNEL_6
7.    GXAO_CHANNEL_7
pnWaveformType
PSHORT
Waveform type:
0.      GXAO_1632_WAVEFORM_SINE
1.      GXAO_1632_WAVEFORM_SQUARE
2.      GXAO_1632_WAVEFORM_TRIANGLE
3.      GXAO_1632_WAVEFORM_RAMP_UP
4.      GXAO_1632_WAVEFORM_RAMP_DOWN
5.    GXAO_1632_WAVEFORM_DC
pdAmplitude
PDOUBLE
Waveform peak-to-peak amplitude voltage, valid range is 0 to 50. 
pdOffset
PDOUBLE
DC offset applied to the waveform, valid range is -25 to 25 Volts.
pdFrequency
PDOUBLE
Frequency of the waveform in Hertz, valid range is 50 to 100000 (50 Hz to 100 kHz).
pdStartPhase
PDOUBLE
Start phase of the waveform in degrees, valid range is -360 to 360.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Using this function will only read the waveform characteristics currently programmed to cached memory.  It does not measure any of the characteristics from the active waveform.

Example

The following example reads the programmed waveform configuration from the specified channel:

 

SHORT  nWaveformType, nStatus;

DOUBLE dAmplitude, dOffset, dFrequency, dStartPhase;

 

GxAoStandardWaveformGetConfiguration(nHandle, GXAO_GROUPD, GXAO_CHANNEL_2, &nWaveformType, &dAmplitude, &dOffset, &dFrequency, &dStartPhase, &nStatus);

 

See Also

GxAoStandardWaveformSetConfiguration, GxAoGetErrorString