GtDio6xSequencerSetRecordParameters

Applies To

GX5296, GX5961, GX5964, File

Purpose

Sets the sequencer record parameters.

Syntax

GtDio6xSequencerSetRecordParameters (nHandle, nCompareInput, nResponseLogic, nType, nRecordMode, 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.
nCompareInput
SHORT
Sets the input comparator data mode. Allows the user to select how the response data will be evaluated for errors when the record mode is set to "Record Errors".

0.    GTDIO6X_RECORD_DUAL COMPARATOR: Use both good 1 and good 0 comparator levels (Dual threshold).

1.    GTDIO6X_RECORD_SINGLE COMPARATOR: Use only the good 1 comparator (Single threshold).
nResponseMode
SHORT
Sets the Response Data Mode.

0.  GTDIO6X_RECORD_GOOD_0: Use good 0.

1.  GTDIO6X_RECORD_GOOD_1: Use good 1.

Allows the user to select which comparator will be used to determine the data level when the record mode is set to "Record Response".
nType
SHORT
Sets how the recorded data will be stored.

0.    GTDIO6X_RECORD_NORMAL_VECTOR_ALIGNED: Data is recorded in the record memory with the same offset as the vector memory.

1.   GTDIO6X_RECORD_INDEXED_SEQUENTIAL: Data is recorded sequentially starting at offset0. The record index memory stores information that allows the recorded data to be aligned with the vector data.
nRecordMode
SHORT
Sets the sequencer record mode. The sequencer record mode is used to select how the record memory is accessed when the sequence step disables the memory, values are:
0.       GTDIO6X_SEQUENCER_RECORD_MODE_DISABLED: The contents of the record memory are unchanged when the step record mode is set to None (GTDIO6X_STEP_RECORD_MODE_DISABLED) or Count (GTDIO6X_STEP_RECORD_MODE_RTC_COUNT_ADDRESS), then the record memory will be not be written to.
1.       GTDIO6X_SEQUENCER_RECORD_MODE_SET_TO_ZERO: The contents of the record memory are set to 0 (No Error) when the step record mode is set to None (GTDIO6X_STEP_RECORD_MODE_DISABLED) or Count (GTDIO6X_STEP_RECORD_MODE_RTC_COUNT_ADDRESS), then the record memory will be not be written to.
GX5296: Not supported.
pnStatus
PSHORT
Returned status: 0 on success, negative value on failure.

Comments

The record mode is set for each step using the GtDio6xStepSetRecordMode  function.

GX5961 and GX5964: The Record Offset should be set to approximately 20-30 master clock periods to compensate for internal system delay.

Example

The following example sets sequencer record parameters as follows:

Dual Comparator, the response mode to Good 0, the record type to Normal, and the record mode to disable, and returns the settings:

 

SHORT nCompareInput, nResponseLogic, nType, nRecordMode;

SHORT nStatus;

 

GtDio6xSequencerSetRecordParameters (nHandle, GTDIO6X_RECORD_DUAL COMPARATOR, GTDIO6X_RECORD_GOOD_0, GTDIO6X_RECORD_NORMAL_VECTOR_ALIGNED, GTDIO6X_SEQUENCER_RECORD_MODE_DISABLED, &nStatus);

 

GtDio6xSequencerGetRecordParameters (nHandle, &nCompareInput, &nResponseLogic, &nType, &nRecordMode, &nStatus);

 

See Also

GtDio6xSequencerGetRecordParameters, GtDio6xStepSetRecordMode, GtDio6xReadRecordMemory, GtDio6xReadVectorMemory, GtDio6xWriteVectorMemory, GtDio6xGetErrorString