pause

Pause stimulation of root inports of model on target computer

collapse all in page

Syntax

pause(target_stimulation_object, inports)
pause(target_stimulation_object, playbacks)
pause(target_stimulation_object,'all')
pause(target_stimulation_object,blockPath)

Description

pause(target_stimulation_object, inports) pauses the stimulation of the specified root inports of the model running on the Speedgoat® target computer.

example

pause(target_stimulation_object, playbacks) pauses the stimulation of the specified Playback blocks in the model running on the target computer.

example

pause(target_stimulation_object,'all') pauses the stimulation of all root inports, Playback blocks, and tunable parameters in the model running on the target computer.

example

pause(target_stimulation_object,blockPath) pauses the stimulation of the specified root inports, Playback blocks, and tunable parameters in the model running on the target computer.

example

Examples

collapse all

In a model with five inports, pause the stimulation of inports named first and third.

pause(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:
%
% pause(tg.Stimulation,[1,3]);

In a model with five Playback blocks, pause the stimulation of Playback blocks named first and third.

pause(tg.Stimulation,{'first','third'});

In a model with five inports, pause the stimulation of all inports and Playback blocks.

tg.Stimulation.pause('all');

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

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

Input Arguments

collapse all

Object that represents the stimulation of root inports or Playback blocks of the model running on the Speedgoat target computer. A Target.Stimulation object is created when you create a Target object by using the slrealtime command.

Example: tg.Stimulation

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

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

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

Example: 'all'

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

expand all

See Also

| | | | |

Topics