getStatus

Return status of root inports stimulation of model on target computer

Syntax

getStatus(target_object.Stimulation,inports)

getStatus(target_object.Stimulation,'all')

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, PAUSED, or STOPPED.

getStatus(target_object.Stimulation,'all') returns the status of the stimulation of all root inports of 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 All Inports

Get the status of stimulation of all inports.

tg.Stimulation.getStatus('all');

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'}

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'

Version History

Introduced in R2021a