ssIsModeUpdateTimeStep

Determine whether update to mode vector is allowed on time step

Since R2022b

Syntax

boolean_T ssIsModeUpdateTimeStep(SimStruct *S)

Arguments

S: SimStruct that represents an S-Function block.

Returns

true or 1 when updating the mode is allowed on the current time step. Otherwise, returns false or 0.

Description

Use this function to determine whether the simulation is currently running a time step where an update of the mode vector is allowed.

Write the mode update code that uses this function in the mdlOutputs method for the block. To get the mode vector, use the ssGetModeVector function.

Languages

C, C++

Examples

See the S-function sfun_zc_pwm.c used in the model sfcndemo_sfunc_zc_pwm.
See the S-function sfun_zc.c used in the model sfcndemo_sfun_zc.
See the S-function sfun_zc_sat.c used in the model sfcndemo_sfun_zc_sat.

Version History

Introduced in R2022b