ssSampleAndOffsetAreTriggered

Determine whether a sample time and offset value pair indicate a triggered sample time

Syntax

boolean_T ssSampleAndOffsetAreTriggered(real_T st, real_T ot)

Arguments

st: The sample time.
ot: The offset time.

Returns

The Boolean value true if both st and ot are equal to INHERITED_SAMPLE_TIME. Otherwise, returns false.

Description

The Simulink^® engine sets the sample time and offset pairs of a block or its ports (for port-based sample times) to INHERITED_SAMPLE_TIME if the block resides in a triggered subsystem. By invoking this macro on its sample time/offset pairs, an S-function can determine whether it resides in a triggered subsystem.

Languages

C, C++

Examples

See the S-function sfun_port_triggered.c used in sfcndemo_port_triggered.

Version History

Introduced before R2006a