GtDio6xTrigConfigGetPhaseResumeTrigger

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the phase resume trigger settings.

Syntax

GtDio6xTrigConfigGetPhaseResumeTrigger (nHandle, nPhaseResumeTriggerNumber, pnTriggerSource, pbInvertTriggerSource, pnLevelOrEdge, 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.

nPhaseResumeTriggerNumber
SHORT
Set the phase resume trigger number as follows:
0.       GTDIO6X_PHASE_RESUME_TRIGGER_0: Phase Resume Trigger 0.
1.    GTDIO6X_PHASE_RESUME_TRIGGER_1: Phase Resume Trigger 1.
2.    GTDIO6X_PHASE_RESUME_TRIGGER_2: Phase Resume Trigger 2.
3.    GTDIO6X_PHASE_RESUME_TRIGGER_3: Phase Resume Trigger 3.
pnTriggerSource
PSHORT
Returns the trigger source as follows:

0.    GTDIO6X_TRIGGER_SOURCE_NONE: No Signal is used as the pause resume trigger source.

1.    GTDIO6X_TRIGGER_SOURCE_AUX_0: Auxiliary channel 0 used as the pause resume trigger source.

2.    GTDIO6X_TRIGGER_SOURCE_AUX_1: Auxiliary channel 1 used as the pause resume trigger source.

3.    GTDIO6X_TRIGGER_SOURCE_AUX_2: Auxiliary channel 2 used as the pause resume trigger source.

4.    GTDIO6X_TRIGGER_SOURCE_AUX_3: Auxiliary channel 3 used as the pause resume trigger source.

5.    GTDIO6X_TRIGGER_SOURCE_AUX_4: Auxiliary channel 4 used as the pause resume trigger source. GX5961 only.

6.    GTDIO6X_TRIGGER_SOURCE_AUX_5: Auxiliary channel 5 used as the pause resume trigger source. GX5961 only.

7.    GTDIO6X_TRIGGER_SOURCE_AUX_6: Auxiliary channel 6 used as the pause resume trigger source. GX5961 only.

8.    GTDIO6X_TRIGGER_SOURCE_AUX_7: Auxiliary channel 7 used as the pause resume trigger source. GX5961 only.

9.    GTDIO6X_TRIGGER_SOURCE_AUX_8: Auxiliary channel 8 used as the pause resume trigger source. GX5296 TTL Input, GX5961 TTL Input/Output.

10. GTDIO6X_TRIGGER_SOURCE_AUX_9: Auxiliary channel 9 used as the pause resume trigger source. GX5296 TTL Input, GX5961 TTL Input/Output.

11.  GTDIO6X_TRIGGER_SOURCE_AUX_10: Auxiliary channel 10 used as the pause resume trigger source. GX5296 TTL Input, GX5961 TTL Input/Output.

12.  GTDIO6X_TRIGGER_SOURCE_AUX_11: Auxiliary channel 11 used as the pause resume trigger source. GX5296 TTL Input, GX5961 TTL Input/Output.

13.  GTDIO6X_TRIGGER_SOURCE_CH_COMPARE_0: Channel Test Signal 0 used as the pause resume trigger source.

14.  GTDIO6X_TRIGGER_SOURCE_LOCAL_BUS: Domain Resource used as the pause resume trigger source.

15.  GTDIO6X_TRIGGER_SOURCE_PXI_0: PXI Trigger 0 used as the pause resume trigger source.

16.  GTDIO6X_TRIGGER_SOURCE_PXI_1 PXI Trigger 1 used as the pause resume trigger source.

17.  GTDIO6X_TRIGGER_SOURCE_PXI_2 PXI Trigger 2 used as the pause resume trigger source.

18.  GTDIO6X_TRIGGER_SOURCE_PXI_3 PXI Trigger 3 used as the pause resume trigger source.

19.  GTDIO6X_TRIGGER_SOURCE_PXI_4 PXI Trigger 4 used as the pause resume trigger source.

20.  GTDIO6X_TRIGGER_SOURCE_PXI_5 PXI Trigger 5 used as the pause resume trigger source.

21.  GTDIO6X_TRIGGER_SOURCE_PXI_6 PXI Trigger 6 used as the pause resume trigger source.

22.  GTDIO6X_TRIGGER_SOURCE_PXI_7 PXI Trigger 7 used as the pause resume trigger source.

pbInvertTriggerSource
PBOOL
Used to return the trigger inverter state as follows:

0.    FALSE: Disable signal inverter, do not modify input signal before testing.

1.    TRUE: Enable signal inverter, invert input signal before testing.

pnLevelOrEdge
PSHORT
Used to return the trigger test mode as follows:

0.    GTDIO6X_TRIGGER_ON_LOW_LEVEL: Trigger when a low logic level is detected.

1.    GTDIO6X_TRIGGER_ON_HIGH_LEVEL: Trigger when a high logic level is detected.

2.    GTDIO6X_TRIGGER_ON_RISING_EDGE: Trigger when a rising edge is detected.

3.    GTDIO6X_TRIGGER_ON_FALLING_EDGE: Trigger when a falling edge is detected.

pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

 

Comments

This function sets the phase resume trigger. If the pattern timing is paused by either the assert or return edge of a phase, then this trigger is used to resume the timing.

Configuring the phase resume trigger consists of the following:

1.    Selecting the resume phase number to configure.

2.    Selecting the resume source.

3.    Program the resume source inverter.

4.    Select the resume test mode, level (high/low) or edge (rising/falling).

The Pause logic allows the user to assign a signal (Pause) that can be either an internal or external, which will halt the sequencer. When halted, the following hardware will stop:

     Phases.

     Windows.

     Waveforms.

For each pause signal selection, there is a corresponding signal that will continue (Resume) sequence operation.

See he GtDio6xStepSetPauseResumeTrigger API for more details.

Example

The following example the phase resumes trigger settings as follows:

1.  Configure resume phase resume trigger 0.

2.  Selecting the phase resume trigger source to auxiliary channel 0.

3.  Program the resume source inverter to true.

4.  Select the phase resume trigger test mode to trigger when a high logic level is detected.

 

SHORT nPhaseResumeTriggerNumber, nTriggerSource, nLevelOrEdge, nStatus;

BOOL bInvertTriggerSource;

 

GtDio6xTrigConfigSetPhaseResumeTrigger(nHandle, GTDIO6X_PHASE_RESUME_TRIGGER_1, GTDIO6X_TRIGGER_SOURCE_AUX_0, TRUE, GTDIO6X_TRIGGER_ON_HIGH_LEVEL, &nStatus);

GtDio6xTrigConfigGetPhaseResumeTrigger(nHandle, GTDIO6X_PHASE_RESUME_TRIGGER_1, &nTriggerSource, &bInvertTriggerSource, &nLevelOrEdge, &nStatus);

 

See Also

GtDio6xTrigConfigSetHaltTrigger, GtDio6xTrigConfigSetJumpTrigger, GtDio6xTrigConfigSetLocalBusTriggerSource, GtDio6xTrigConfigSetPauseResumeTrigger, GtDio6xTrigConfigSetPxiTrigger, GtDio6xTrigConfigSetRunTrigger, GtDio6xTrigConfigSetStopTrigger, GtDio6xGetErrorString