SLDRT.run

Run model in real time by using Simulink Desktop Real-Time kernel

Since R2023b

Syntax

statusObject = SLDRT.run(modelName)

statusObject = SLDRT.run(modelName,Name=Value)

Description

statusObject = SLDRT.run(modelName) runs a Simulink^® model in real time by using the Simulink Desktop Real-Time™ kernel.

statusObject = SLDRT.run(modelName,Name=Value) runs a Simulink model in real time by using the Simulink Desktop Real-Time kernel using one or more name-value pair arguments.

Examples

Run a Model in Real-Time Kernel

This example runs the sldrtex_counter model in the real-time kernel. The command creates a SLDRT.RunStatus object that provides information about the model run.

openExample('sldrtex_counter');
myRunStatus = SLDRT.run('sldrtex_counter',Verbose="off");

Input Arguments

modelName — Name of model

character vector | string scalar

Name of the model for the simulation, specified as a character vector or string scalar.

Example: 'sldrtex_counter'

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: Wait="off"

Wait — Option to wait for simulation to stop

"on" (default) | "off"

Option to cause MATLAB to wait for the simulation run to stop, specified as "on" or "off".

Example: Wait="off"

SimulationMode — Option to override simulation mode

mode from model (default) | "kernel" | "external" | "connectedio" | "normal"

Option to override the real-time run mode selected in the model. The available choices are "kernel" or "external" for kernel mode, and "connectedio" or "normal" for connected IO mode. When the SimulationMode value is empty (''), the simulation uses the mode selected by the model. For more information on simulation modes, see Simulate Model in Connected IO Mode and Real-Time Execution in Run in Kernel Mode.

Example: SimulationMode="kernel"

StopTime — Option to override stop time

stop time from model (default) | string

Option to override the model stop time. When the StopTime value is empty (''), the simulation uses the stop time selected by the model.

Example: StopTime="inf"

CaptureAllScopes — Option to enable data capture from scopes

"off" (default) | "on"

Option to specify whether to capture data from all scopes.

Example: CaptureAllScopes="off"

LoadOnly — Option to enable load system of model

"off" (default) | "on"

Option to specify whether the function opens the model in the Simulink editor (if value is "off") or only loads the model (if value is "on") for simulation.

Example: LoadOnly="off"

Verbose — Option to enable verbose output mode

"off" (default) | "on"

Option to enable verbose output mode (if value is "on").

Example: Verbose="off"

Output Arguments

statusObject — Object that provides simulation run status and data

SLDRT.RunStatus object

Object that provides simulation run status and provides access to data from scopes and logged signals after the simulation run completes. Returned as a SLDRT.RunStatus object.

Version History

Introduced in R2023b