Main Content

add_line

Add line to Simulink model

collapse all in page

Syntax

h = add_line(sys,out,in)
h = add_line(sys,out,in,'autorouting',autoOption)
h = add_line(sys,points)

Description

example

h = add_line(sys,out,in) adds a line in the model or subsystem sys that connects one block's output port out to another block's input port in. This syntax draws the most direct route from port to port, for example, diagonal lines or lines that go through other blocks.

You can connect ports when:

  • The input port does not already have a connection.

  • The ports are compatible for connecting.

example

h = add_line(sys,out,in,'autorouting',autoOption) connects blocks, specifying whether to route the lines around other blocks.

example

h = add_line(sys,points) adds a line drawn by (x,y) coordinate points relative to the upper-left corner of the Simulink® Editor canvas before any canvas resizing. If either end of the line is within five pixels of a corresponding port, the function connects the line to it. The line can have multiple segments.

Examples

collapse all

Use the block port numbers to add a line to connect blocks.

Create and open a model.

open_system(new_system('connect_model'));

Add and position a Constant block and a Gain block.

add_block('simulink/Commonly Used Blocks/Constant','connect_model/Constant');
set_param('connect_model/Constant','position',[140,80,180,120]);
add_block('simulink/Commonly Used Blocks/Gain','connect_model/Gain');
set_param('connect_model/Gain','position',[220,80,260,120]);

Connect the blocks. Specify port 1.

add_line('connect_model','Constant/1','Gain/1');

Get the port handles and connect the ports using add_line.

Open the model vdp.

open_system('vdp');

Delete the line that connects the Gain block named Mu to the Sum block.

delete_line('vdp','Mu/1','Sum/2');

Get the port handles from the Mu block and the Sum block.

h = get_param('vdp/Mu','PortHandles');
h1 = get_param('vdp/Sum','PortHandles');

Look at the h1 structure. Notice the two handles for the Inport property.

h1
h1 = 

  struct with fields:

      Inport: [47.0002 54.0002]
     Outport: 39.0002
      Enable: []
     Trigger: []
       State: []
       LConn: []
       RConn: []
    Ifaction: []
       Reset: []

Index into the Outport and Inport properties on the port handles to get the handles you want and connect them. Connect to the second inport.

add_line('vdp',h.Outport(1),h1.Inport(2));

You can branch a line by adding a connection programmatically. You can use the points syntax to draw the segment, or you can draw the line by specifying the ports to connect. When using the port, use automatic line routing to improve the look of the branched line.

Add a scope to the vdp model above the outport.

vdp
add_block('simulink/Commonly Used Blocks/Scope','vdp/Scope1');
set_param('vdp/Scope1','position',[470,70,500,110]);

Connect the Integrator block x1 to Scope1. This code branches the existing line from the x1 output and connects it to the scope. With autorouting on, the resulting line is segmented.

add_line('vdp','x1/1','Scope1/1','autorouting','on')

You can use points on the canvas as the start and end of each segment. Get the port locations using get_param with the 'PortConnectivity' option.

Open the model vdp and delete the line that connects the Mu and Sum blocks.

vdp
delete_line('vdp','Mu/1','Sum/2')

Get the port locations for Mu. Mu has two ports. The first is the input port, and the second is the output port. 

mu = get_param('vdp/Mu','PortConnectivity');
mu.Position
ans =

   190   150


ans =

   225   150

Get the port locations for Sum, which has three ports. The second position is the lower input port. 

s = get_param('vdp/Sum','PortConnectivity');
s.Position
ans =

   250   135


ans =

   250   150


ans =

   285   145

Connect the ports using the output and input points.

add_line('vdp',[225 150; 250 150])

Add lines with and without autorouting options.

Create a model route. Display default block names.

open_system(new_system('route'));
set_param('route','HideAutomaticNames','off')

Add two Subsystem blocks and a Gain block. Add an inport and outport to each Subsystem block.

Two Subsystem blocks, each with two inports and two outports. Midway between them is a Gain block. The blocks are not connected.

Add lines to connect the outports of the Subsystem1 block to the inports of the Subsystem block. 

add_line('route',{'Subsystem/1','Subsystem/2'},...
      {'Subsystem1/1','Subsystem1/2'})

Because you did not use the autorouting options, the function draws straight lines that cross over the Gain block.

Two outports of a Subsystem on the left connect to two inports of a Subsystem on the right. The two signal lines connecting these ports cross over a Gain block. The Gain block is not connected.

Delete the lines. Add lines again, this time with the autorouting option set to 'on'.

add_line('route',{'Subsystem/1','Subsystem/2'},...
      {'Subsystem1/1','Subsystem1/2'},'autorouting','on')

The lines route around the Gain block.Two outports of a Subsystem on the left connect to two inports of a Subsystem on the right. The two signal lines connecting these ports are routed around the Gain block icon, but one crosses over the block name. The Gain block is not connected.

Delete the lines. Add lines again, using the smart autorouting option. When you use an array to connect two sets of inports and outports, smart autorouting routes them together if doing so makes better use of the space.

add_line('route',{'Subsystem/1','Subsystem/2'},...
      {'Subsystem1/1','Subsystem1/2'},'autorouting','smart')

Two outports of a Subsystem on the left connect to two inports of a Subsystem on the right. The two signal lines connecting these ports are routed around the Gain block. The Gain block is not connected.

Input Arguments

collapse all

Model or subsystem to add the line to, specified as a character vector.

Example: 'vdp'

Example: 'f14/Controller'

Block output port to connect line from, specified as one of these values:

  • The block name, a slash, and the port number. For a state port, use the port name State instead of a port number.

  • The port handle that you want to connect from.

  • An array of either of these port designators.

Use 'PortHandles' with get_param to get the handles.

Example: 'Mu/1'

Example: 'Subsystem/2'

Example: h.Outport(1)

Example: {'Subsystem/1','Subsystem/2'}

Tips

Block input port to connect line to, specified as one of these values:

  • The block name, a slash, and the port number. Use a port name instead of a port number for these ports:

    • Enable port — Use Enable. For example, use this port name for the enable port on enabled subsystems.

    • Trigger port — Use Trigger. For example, use this port name for the trigger port on triggered subsystems.

    • Action port — Use Ifaction. For example, use this port name for the action port on if-action and switch-case-action subsystems.

  • The port handle that you want to add the line to.

  • An array of either of these port designators.

Use the 'PortHandles' option with get_param to get handles.

Example: 'Mu/1'

Example: 'Subsystem/2'

Example: h.Inport(1)

Example: {'Subsystem/1','Subsystem/2'}

Tips

Type of automatic line routing around other blocks, specified as:

  • 'off' for no automatic line routing

  • 'on' for automatic line routing

  • 'smart' for automatic line routing that takes the best advantage of the blank spaces on the canvas and avoids overlapping other lines and labels

Points of the line to draw, specified as at least a 2-by-2 matrix. Add a row for every segment you want to draw. Specify points as (x,y) coordinates from the upper-left corner of the Editor before any canvas resizing.

Example: [100 300; 200 300; 200 300; 200 500]

Output Arguments

collapse all

Line created by add_line, returned as a handle.

Version History

Introduced before R2006a

See Also

| | | |

Topics