Main Content

start

Start stimulation of root inports of model on target computer

Since R2021a

Description

example

start(target_object.Stimulation,inports) starts the stimulation of specified root inports of the model running on the target computer.

example

start(target_object.Stimulation,playbacks) starts the stimulation of specified Playback blocks in the model running on the target computer.

example

start(target_object.Stimulation,'all') starts the stimulation of all root inports of the model and Playback blocks in the model running on the target computer.

example

start(target_object.Stimulation,blockPath) starts the stimulation for tunable parameter specified by the block path. The function uses the currently active XCP page.

Examples

collapse all

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

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

In a model with five Playback blocks, start the stimulation of Playback blocks named playThis and playThat.

start(tg.Stimulation,{'playThis','playThat'});

In a model with five inports, start the stimulation of all inports.

start(tg.Stimulation,'all');

In a model with tunable parameters, start 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.

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

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

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