GtDio6xSequencerGetChannelsCompareTrigger

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns one of the four channel tests.

Syntax

GtDio6xSequencerGetChannelsCompareTrigger (nHandle, nChannelTest, pdwExpect, pdwMask, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Session identifier:

●     Board handle is used when communicating with the hardware. The Board handle session identifier is returned by calling GtDio6xInitialize or GtDio6xSetupInitialization.

●     File handle is used when communicating with a file. The File handle session identifier is  returned by calling GtDio6xFileOpen.
nChannelTest
SHORT
Selects one of four channel tests to configure:

0.  GTDIO6X_CHANNELS_COMPARE_TRIGGER_0: Channels compare trigger 0.

1.  GTDIO6X_CHANNELS_COMPARE_TRIGGER_1 Channels compare trigger 1.

2.  GTDIO6X_CHANNELS_COMPARE_TRIGGER_2 Channels compare trigger 2.

3.  GTDIO6X_CHANNELS_COMPARE_TRIGGER_3 Channels compare trigger 3.
pdwExpect
PDWORD
Used to return the channel test expect value. Each bit corresponds to a channel, Bit 0 of the expect value maps to the lowest channel of this sequencer and Bit 31 maps to the highest channel. E.g. Bit 0 - Channel 0 expect,  Bit 31 - Channel 31.
A one represents a valid high test and a zero represent a valid low test.
The expect is compared to the response high of the input channel.
Valid Range 0-0xFFFFFFFF for the GX5296 and GX5964 and 0-0xFFFF for the GX5961.
pdwMask
PDWORD
Used to return the channel test mask value. Each bit corresponds to a channel, Bit 0 of the mask value maps to the lowest channel of this sequencer and Bit 31 maps to the highest channel.
E.g. Bit 0 - Channel 0 mask, Bit 31 - Channel 31.
A one disables (masks) the comparison to the expect value and a zero enables the comparison.
Valid Range: 0-0xFFFFFFFFfor the GX5296 and GX5964 and 0-0xFFFF for the GX5961.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The user can set up four different channel tests, and rout each to different source.

GTDIO6X_CHANNELS_COMPARE_TRIGGER_0: can be routed to:

●     GTDIO6X_JUMP_TRIGGER_0 to GTDIO6X_JUMP_TRIGGER_3, using GtDio6xTrigConfigSetJumpTrigger API.

●     GTDIO6X_PXI_TRIGGER_LINE0 to GTDIO6X_PXI_TRIGGER_LINE7, using GtDio6xTrigConfigSetPxiTrigger API.

●     Start trigger API, and be the source to start running using the GtDio6xTrigConfigSetRunTrigger API.

●     Stop trigger API, and be the source to stop running using the Stop GtDio6xTrigConfigSetStopTrigger API.

●     Halt the sequencer GtDio6xTrigConfigSetHaltTrigger API, the halt mode can be set using the GtDio6xSequencerSetHaltMode API.

●     Pause the sequencer and /or resume using GtDio6xTrigConfigSetPauseResumeTrigger API.

●     Resume based on the phase using GtDio6xTrigConfigSetPhaseResumeTrigger API.

Example

The following example configures Channel Test 1 on the 32 channel GX5964with an expected value of 0x1234 and all other bits masked off:

 

SHORT nStatus;

DWORD dwExpect, dwMask;

 

GtDio6xSequencerSetChannelsCompareTrigger(nHandle, GTDIO6X_CHANNELS_COMPARE_TRIGGER_1, 0x1234, 0x0FFF0000, &nStatus);

 

GtDio6xSequencerGetChannelsCompareTrigger(nHandle, GTDIO6X_CHANNELS_COMPARE_TRIGGER_1, &dwExpect, &dwMask, &nStatus);

 

See Also

GtDio6xSequencerArm, GtDio6xSequencerArmIdleStep, GtDio6xSequencerHalt, GtDio6xSequencerReset, GtDio6xSequencerResume, GtDio6xSequencerRun, GtDio6xSequencerRunEx,GtDio6xSequencerRunIdleStep, GtDio6xSequencerSetBurstCount, GtDio6xSequencerSetChannelsCompareTrigger, GtDio6xSequencerSetRunCompletionMode,  GtDio6xSequencerSetFreqSynth, GtDio6xSequencerSetHaltMode, GtDio6xSequencerSetIdleStep, GtDio6xSequencerSetLoopCounterMode, GtDio6xSequencerSetMasterClockSource, GtDio6xSequencerSetRecordOffset, GtDio6xSequencerSetRecordParameters, GtDio6xSequencerSetStopMode, GtDio6xSequencerSetSyncPulseSource, GtDio6xSequencerSetSyncPulseParameters, GtDio6xSequencerSetSystemClockExternal,  GtDio6xSequencerSetSystemClockSource, GtDio6xSequencerStop, GtDio6xGetErrorString