Main Content

getStatus

Return status of root inports stimulation of model on target computer

Description

example

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.

example

getStatus(target_object.Stimulation,'all') returns the status of the stimulation of all root inports of the model running on the target computer.

Examples

collapse all

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

Get the status of stimulation of all inports.

tg.Stimulation.getStatus('all');

Input Arguments

collapse all

Provides access to methods that manipulate the target computer properties.

Example: tg

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

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

Example: 'all'

Introduced in R2021a