GtWaveArbGetSampleRate

Supported By

GX1110, GX1120

Applies To

Arbitrary Waveform Generator mode only.

Purpose

Returns the data point sampling rate.

Syntax

GtWaveArbGetSampleRate (nHandle, nChannel, pdSampleRate, 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.
pdSampleRate
PDOUBLE
GX1120:
Returns the data point sampling rate, sampling rate can be between 1S/sec to 100MS/Sec.
GX1120: Returns the data point sampling rate, sampling rate can be between 0.01S/Sec to 250MS/Sec.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Frequency accuracy of the output waveform is determined by the clock reference. If higher accuracy and/or stability is required, an external frequency reference can be used to replace the internal 10MHz reference clock.

The waveform frequency is given by the following equation: Frequency = 1/(Sample Rate * Wavelength)

Example

The following example returns the data point sampling rate:

 

DOUBLE dSampleRate;

GtWaveArbGetSampleRate (nHandle, GTWAVE_CHANNEL_A, &dSampleRate, &nStatus);

 

See Also

GtWaveArbSetSampleRate, GtWaveArbSetMarker, GtWaveArbSetWaveformLength, GtWaveArbSetSync, GtWaveArbFillPredefinedWaveform, GtWaveArbReadWaveformData, GtWaveArbWriteWaveformData, GtWaveArbFileLoad, GtWaveArbFileSave