states

Display state values during simulation debugging session

Syntax

states

Description

states displays in the MATLAB^® Command Window the current state values for the model running in the current simulation debugging session. The information displayed for each state includes the state index, state value, and block name.

You can use this function in a simulation debugging session started:

• Interactively, using the Simulink^® Toolstrip

• Programmatically, using the sldebug function

• Programmatically, using the sim function with the 'debug' name-value argument

Note

This function is available only for simulation debugging sessions started programmatically and for interactive simulation debugging sessions while paused within a time step.

Examples

Display State Values During Simulation Debugging Session

Use the states function to display the current values for states in the model vdp in a simulation debugging session.

Open the model vdp.

openExample("simulink_general/VanDerPolOscillatorExample",...
    supportingFile="vdp")

Start a simulation debugging session for the model vdp using the sldebug function. The MATLAB command prompt (>>) becomes the Simulink debugger prompt ((sldebug @0): >> ).

sldebug vdp

(sldebug @0): >> 

Use the states function to view a list of states in the model and their current values.

states

Continuous States for 'vdp':
 Idx  Value                   (system:block:element  Name   'BlockName')
  0. 0                        (0:0:0  CSTATE  'vdp/x1')
  1. 0                        (0:2:0  CSTATE  'vdp/x2')

When you have finished debugging, use the stop function to end the simulation debugging session.

stop

Tips

To start a simulation debugging session interactively, add one or more breakpoints to your model, and in the Breakpoints List, check that Pause within time step is selected. When the simulation pauses on a breakpoint, some of the programmatic debugging commands, such as the stop command, are available for use in the MATLAB Command Window.

Version History

Introduced before R2006a

R2024a: sldebug prompt in MATLAB Command Window indicates when simulation debugging session is paused within time step

When you start a simulation debugging session using the Simulink Editor, you can issue some programmatic simulation debugging commands, such as probe or stop, while the simulation is paused within a time step. The sldebug command prompt (sldebug>>) now replaces the MATLAB command prompt (>>) to indicate in the MATLAB Command Window when the simulation is paused within a time step. As in prior releases, you can issue both MATLAB commands and the supported simulation debugging commands at the sldebug command prompt.

For more information, see Simulink Debugging Programmatic Interface.