getStatus

Return status of root inports stimulation of model on target computer

Since R2021a

Syntax

getStatus(target_object.Stimulation,inports)

getStatus(target_object.Stimulation,playbacks)

getStatus(target_object.Stimulation,'all')

getStatus(target_object.Stimulation,blockPath)

Description

getStatus(target_object.Stimulation,inports) returns the status of the stimulation of specified root inports of the model running on the target computer. The status of the stimulation can be:

• RUNNING — indicates that stimulation is running

• PAUSED — indicates that stimulation is paused

• isFinished — indicates that stimulation data is finished

• STOPPED — indicates that stimulation is stopped

getStatus(target_object.Stimulation,playbacks) returns the status of the stimulation of specified Playback blocks in the model running on the target computer. The status of the stimulation can be RUNNING, PAUSED, isFinished, or STOPPED.

getStatus(target_object.Stimulation,'all') returns the status of the stimulation of all root inports, Playback blocks, and tunable parameters in the model running on the target computer.

getStatus(target_object.Stimulation,blockPath) returns the status of the stimulation of the specified root inports, Playback blocks, and tunable parameters after the previous step in the model running on the target computer.

Examples

Return Stimulation Status of Specific Inports

Get the status of stimulation of inports named first and third.

status = getStatus(tg.Stimulation,{'first','third'});
% if the port number of inport named 'first' is 1
% and the port number of inport named 'third' is 3
% this syntax is equivalent to:
%
% status = getStatus(tg.Stimulation,[1,3]);

status = 

  struct with fields:

    first: RUNNING
    third: RUNNING

Return Stimulation Status of Specific Playback Blocks

Get the status of stimulation of Playback blocks named first and third.

status = getStatus(tg.Stimulation,{'first','third'});

status = 

  struct with fields:

    first: RUNNING
    third: RUNNING

Return Stimulation Status of All Inports and Playback Blocks

Get the status of stimulation of all inports and Playback blocks.

tg.Stimulation.getStatus('all');

Get Stimulation Status of Specific Tunable Parameters

In a model with tunable parameters, get the stimulation status of parameters with block path slrt_ex_osc/Signal Generator. For more information finding the block path for parameters, see Simulink Real-Time Explorer.

getStatus(tg.Stimulation,'slrt_ex_osc/Signal Generator');

Input Arguments

target_object — Object that represents target computer

slrealtime.Target object

Provides access to methods that manipulate the target computer properties.

Example: tg

inports — Specific inports of the model on target computer

array of inport numbers | cell array of inport names | cell array of inport block paths

Specifies the numbers of the inports or names of the inports or block paths of the inports present on the model running on the target computer.

Example: [1,3,5], {'in1','in2'}, {'model_name/in1','model_name/in4'}

playbacks — Specific Playback blocks in the model on target computer

cell array of Playback block names | cell array of Playback block paths

Specifies the block names or block paths of the Playback blocks present in the model running on the target computer. If you use a block name that is not unique (more than one block with that name is present) in the model, the function returns an error and suggests using block paths instead.

Example: {'pb1','pb2'}, {'model_name/pb1','model_name/pb4'}

all — All the root inports of the model on target computer

'all'

Represents all the available root inports of the model running on the target computer.

Example: 'all'

blockPath — Hierarchical name of the originating block of the tunable parameter

character vector | string scalar | cell array of character vectors or strings

The block_path values for tunable parameters in stimulation operations can be:

• Empty character vector ('') or empty string scalar ("") for base or model workspace variables

• Character vector or string scalar string for block path to parameters in the top model

• Cell array of character vectors or string scalars for model block arguments

Example: '', 'Gain1', {'top/model','sub/model'}

Version History

Introduced in R2021a

R2023b: Apply simulation support for tunable parameters

In R2023b, the stimulation-related functions start, stop, getStatus, reloadData, and pause support tunable parameters in addition to signals.