ssIsSampleHit - Determine whether the sample time is hit

Syntax

boolean_T ssIsSampleHit(SimStruct *S, int_T st_index, int_T tid)

Arguments

S

SimStruct representing an S-Function block.

st_index

Index of the sample time.

tid

Task ID.

Returns

The Boolean value true when the simulation is executing in the task represented by task ID tid. Otherwise, returns false.

Description

Use in mdlOutputs or mdlUpdate when your S-function has multiple sample times to determine the task your S-function is executing in. You should not use this in single-rate S-functions or for an st_index corresponding to a continuous task.

Languages

C, C++

Example

See the S-function mixedmex.c used in sfcndemo_mixedmex.mdl.

See Also

ssIsContinuousTask, ssIsSpecialSampleHit

Related Products & Applications

• Simulink
• Control Design
• Signal Processing & Communications
• Model-Based Design
• Physical Modeling
• Verification & Validation

Get Simulink trial software

Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.

Get this Simulink Kit