GtDio6xSequencerSetRunCompletionMode

Applies To

GX5961, GX5964, File

Purpose

Sets the sequencer run completion mode.

Syntax

GtDio6xSequencerSetRunCompletionMode (nHandle, lStep, nCompletionMode, 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.

lStep
LONG
Used to specify the sequencer run completion step number, value 0-4095.
nCompletionMode
SHORT
Sets sequencer run completion mode as follows:

0.    GTDIO6X_RUN_COMPLETION_MODE_STANDBY: outputs the first pattern of the specified standby step and vector memory can be accessed by the user.

1.    GTDIO6X_RUN_COMPLETION_MODE_IDLE: outputs the entire pattern set of the specified Idle step and vector memory cannot be accessed.

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

Comments

The sequencer is always outputting vectors, even if it is currently in an idle state (stopped).  Setting the sequencer run completion mode allows the user to select which Step will run when the sequencer is idling. The user can also select if they would like to output only the first Vector assigned to the Step, or all the Vectors assigned to the Step. When the sequencer execution completes, the sequencer will enter either the Standby or Idle state. The Standby state outputs the first pattern of the specified step and pattern memory can be accessed by the user. The Idle state will output the entire pattern set of the specified step and pattern memory cannot be accessed.

Example

The following example sets the sequencer run completion step to step 1, and the sequencer run completion mode to standby, and returns the settings:

 

SHORT nStep , nCompletionMode;

SHORT nStatus;

LONG lStep;

GtDio6xSequencerSetRunCompletionMode (nHandle, GTDIO6X_RUN_COMPLETION_MODE_STANDBY, &nStatus);

GtDio6xSequencerGetRunCompletionMode (nHandle, &lStep, &nCompletionMode, &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