connectLine

Connect signal for streaming to axes

Since R2020b

Syntax

connectLine(instrument_object,hAxis,blockPath,portIndex,Name,Value)

connectLine(instrument_object,hAxis,signalName,Name,Value)

Description

connectLine(instrument_object,hAxis,blockPath,portIndex,Name,Value) connects a signal by using the block path and port index for streaming to axes.

connectLine(instrument_object,hAxis,signalName,Name,Value) connects a signal by using a signal name for streaming to axes.

Examples

Connect Signal by Block Path and Port Index

Connect a signal for streaming to the real-time instrument object and axes object by using the block path and port index.

mldatxfile = 'slrt_ex_tank.mldatx';
hInst  = slrealtime.Instrument(mldatxfile);
connectLine(hInst,myAxis,'slrt_ex_tank/ControlValue',1);

Connect Signal by Signal Name

Connect a signal for streaming to the real-time instrument object and axis object by using a signal name.

% added signal name to model before building mldatxfile
mldatxfile = 'slrt_ex_tank.mldatx';
hInst  = slrealtime.Instrument(mldatxfile);
connectLine(hInst,myAxis,'ControlValueOut');

Input Arguments

instrument_object — Object that represents real-time instrument

object

To create the instrument object, use the Instrument function.

Example: hInst

hAxis — Handle to axis of a figure or UI figure

object

To create an axes object, use hAxis = gca or hAxis = axes ().

Example: myAxes

blockPath — Block path for block with signal connected to one of its outports

character vector

For the selected block, gcb returns the full block path name.

Example: slrt_ex_tank/ControlValue

portIndex — Index of block port that is connected to signal for streaming

integer

For the selected signal, the output port index and signal name are visible in the signal hierarchy available in Simulink Real-Time explorer or in the Model Data Editor.

Example: 1

signalName — Name of signal for streaming

character vector

For the selected signal, the port index and signal name are visible in the signal hierarchy available in Simulink Real-Time explorer or in the Model Data Editor.

Example: ControlValueOut

Name,Value — Pair that set properties values

name-value pair

The Name,Value pair argument selects the signal properties that are added to the instrument object instrument_object and sets values for the properties.

Example: 'Decimation',2

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Decimation',2

ArrayIndex — Array index of multi-element signal

integer

Selects an element of a multi-element signal.

Example: 'ArrayIndex',5

BusElement — Nonvirtual bus element

signal name (character vector)

Specifies a particular element of a nonvirtual bus to stream. The syntax for the BusElement value:

• Starts with the selected index for Array of Buses '(index).' or empty for scalar bus signals

• Contains the path from the first level down to the leaf element

• Separates each level of the hierarchy with a period '.'

• Has a leaf as last level

• Expresses the index for Array of Buses in the path as '(index)'

Example: 'BusElement','u1'

Example: 'BusElement','u4(1).b'

Example: 'BusElement','(1).a'

Callback — Function handle

function handle

Provides function handle for accepting (time,data) arguments and returning data.

Example: 'Callback', @(t,d)(d+app.Offset.Value)

Decimation — Decimation value

1 (default) | numeric, scalar, positive value

Specifies a decimation value for the signal.

Example: 'Decimation',2

LineStyle — LineStyle object selection

slrealtime.instrument.LineStyle object

Select an slrealtime.instrument.LineStyle object that customizes the line appearance. For more information about object, see slrealtime.instrument.LineStyle.

Example: 'LineStyle', objectName

Version History

Introduced in R2020b

R2022b: Select signals by name

In R2022b, you can use a signal name instead of a full block path to create robust binding between a signal and an instrument. This support applies to the SignalTable component and functions such as connectLine or connectScalar.