GtDio6xSequencerGetSyncPulseParameters

Applies To

GX5296, GX5961, GX5964, File

Purpose

Returns the sequencer sync event settings.

Syntax

GtDio6xSequencerGetSyncPulseParameters (nHandle, nSyncOutput, pnVectorOffset, plVectorLength, 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.

nSyncOutput
SHORT
Selects the Sync Output Signal to set:

0.  GTDIO6X_SEQUENCER_SYNC_OUTPUT_1: First sequencer sync output signal.

1.  GTDIO6X_SEQUENCER_SYNC_OUTPUT_2: Second sequencer sync output signal.

plVectorOffset
PLONG
Used to return the sync vector offset. The resolution is in vector clocks. The valid range of values are 0-1048575.
pnVectorLength
PSHORT
Used to return the sync vector length. The resolution is in vector clocks. The valid range of values are 0-4095.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The sync pulse parameters consist of an offset and a length. Once the programmed sync event occurs, the sync pulse will begin after the "offset" and last for "length". Both "offset" and "length" are specified in vector clocks.

The sync pulse will not extend past the end of the sequence. In the "Step" event, the sync pulse will not extend beyond the specified step.

The Sync pulse can be used to set up a break point at a particular data vector.

The sequencer has two sync outputs that can be routed to any of the AUX or PXI outputs as well as a source to the GtDio6xSequencerSetHaltMode API.

Example

The following example sets the Sync 2 event vector offset to 3 and vector length to 10, and returns the settings:

 

SHORT nVectorOffset;

LONG  lVectorLength;

SHORT nStatus;

 

GtDio6xSequencerSetSyncPulseParameters(nHandle, GTDIO6X_SEQUENCER_SYNC_OUTPUT_2, 3, 10, &nStatus);

GtDio6xSequencerGetSyncPulseParameters(nHandle, GTDIO6X_SEQUENCER_SYNC_OUTPUT_2, &lVectorLength, &nVectorOffset, &nStatus);

 

See Also

GtDio6xSequencerSetSyncPulseParameters, GtDio6xSequencerGetSyncPulseSource, GtDio6xGetErrorString