Documentation Center

  • Trial Software
  • Product Updates

ssGetSimStatus

Get the current simulation status of an S-Function block

Syntax

ssGetSimStatus(SimStruct *S, SS_SimStatus *status)

Arguments

S

SimStruct representing an S-Function block.

status

SS_SimStatus object that returns the current simulation status.

Description

Determines the simulation status of the block represented by S and stores the value in the SS_SimStatus object status. The variable status can have one of the following values, defined in simstruc_types.hsimstruc_types.h:

  • SIMSTATUS_STOPPED

    The simulation has terminated

  • SIMSTATUS_UPDATING

    The Simulink® engine is updating the model

  • SIMSTATUS_INITIALIZING

    The simulation is initializing

  • SIMSTATUS_RUNNING

    The simulation is running

  • SIMSTATUS_PAUSED

    The simulation is paused

  • SIMSTATUS_TERMINATING

    The simulation is terminating

  • SIMSTATUS_EXTERNAL

    The simulation is running in external mode

Languages

C, C++

Example

The following lines obtain the current simulation status:

SS_SimStatus status;        // Define the return variable
ssGetSimStatus(S, &status);
Was this topic helpful?