ssGetPortBasedSampleTimeBlockIsTriggered

Determine whether a block that uses port-based sample times resides in a triggered subsystem

Syntax

boolean_T ssGetPortBasedSampleTimeBlockIsTriggered(SimStruct *S)

Arguments

S: SimStruct that represents an S-Function block.

Returns

The Boolean value true if S uses port-based sample times and resides in a triggered subsystem. Otherwise, returns false.

Description

Use this macro in mdlOutputs and mdlUpdate to decode whether to use the block's triggered or nontriggered algorithms to compute its states and outputs.

Note

This macro returns a valid result only after sample time propagation. Thus, you cannot use it in mdlSetInputPortSampleTime and mdlSetOutputPortSampleTime to determine whether a port's sample time is triggered. Use ssSampleAndOffsetAreTriggered instead.

Languages

C, C++

Examples

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

Version History

Introduced before R2006a