DioRealTimeCompareGetStopCondition

Applies To

GX5290, File

Purpose

Returns the comparison stop condition.

Syntax

DioRealTimeCompareGetStopCondition (nHandle, pnCondition, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Board or File Board handle.
pnCondition
PSHORT
Comparison stop mode.
0. DIO_RTC_STOP_ON_FAILURES_COUNT: In this stop condition the board stops when the total number of failures is equal to the number of failures count. If the number of detected failures is less the condition value the board will run to the end of the vector. All boards in the domain will stop when any of the boards meet this condition.
1. DIO_RTC_STOP_ON_FAILURES_COUNT_SAVE_DATA: In this stop condition the board continuously comparing and recording the input data. The trigger for the board to stop is when the detected failures number is equal to the condition failures count number. At that point the DIO will continue to record and compare data until there is no more room in the results memory. In this condition the result memory is operating like a FIFO until stop condition is met. All boards in the domain will stop when any of the boards meet this condition.
2. DIO_RTC_STOP_ON_DATA_VALUE: In this stop condition the board continuously comparing and recording the input data. The trigger for the board to stop is when the input data is equal to the condition data value At that point the DIO will continue to record and compare data until there is no more room in the results memory. In this condition the result memory is operating like a FIFO until stop condition is met. All boards in the domain will stop when any of the boards meet this condition.
4. DIO_RTC_STOP_ON_PROGRAM_COUNTER: In this stop condition the board continuously comparing and record the input data. The trigger for the board to stop is when the program counter value is equal to the condition data value At that point the DIO will continue to record and compare data until there is no more room in the results memory. In this condition the result memory is operating like a FIFO until stop condition is met. All boards in the domain will stop when any of the boards meet this condition.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Each boar in the DIO domain can have its own stop condition. As a result the first board that its stop condition is met will stop all other boards in the domain even if their stop condition is not met yet.

The board has to be in Real Time Compare operating mode prior calling this function. See the DioDomainSetupOperatingMode function for more details.

Note: the Real Time Compare functionality is supported by GX529x boards with firmware versions 0x8A00 and above.

Example

The following example returns the comparison stop condition:

 

SHORT nCondition;

DioRealTimeCompareGetStopCondition (nHandle, &nCondition, &nStatus);

 

See Also

DioRealTimeCompareSetupConditionValue, DioRealTimeCompareSetupDataDelay, DioRealTimeCompareSetupInputDataClockEdge, DioRealTimeCompareSetupResultsDataType, DioRealTimeCompareSetupStopCondition, DioRealTimeCompareWriteExpectedMemory, DioRealTimeCompareWriteMaskMemory, DioRealTimeCompareReadResults