addInteraction

Create new sequence diagram in model

Since R2024b

Syntax

interaction = addInteraction(model,name)

interaction = addInteraction(model,name,CopyFrom=copyFrom)

Description

interaction = addInteraction(model,name) creates a sequence diagram in a System Composer™ model.

interaction = addInteraction(model,name,CopyFrom=copyFrom) creates a copy of the interaction sequence diagram in model model with name name.

Examples

Create New Sequence Diagram

Create a model with a component called Component.

model = systemcomposer.createModel("archModel");
systemcomposer.openModel("archModel");
arch = get(model,"Architecture");
comp = addComponent(arch,"Component");

Create a sequence diagram in the model, and then open the sequence diagram.

interaction = model.addInteraction("NewSequenceDiagram");
interaction.open

Input Arguments

model — Architecture model

model object

Architecture model, specified as a systemcomposer.arch.Model object.

name — Name of interaction

character vector | string

Name of interaction, specified as a character vector or string.

Example: "inhibit"

Data Types: char | string

copyFrom — Interaction to copy from

interaction object

Interaction to copy from, specified as a systemcomposer.interaction.Interaction object.

Example: interaction = addInteraction(model,"NewSequenceDiagram",CopyFrom=originalInteraction)

Output Arguments

interaction — Interaction

interaction object

Interaction, returned as a systemcomposer.interaction.Interaction object.

More About

Definitions

Term	Definition	Application	More Information
sequence diagram	A sequence diagram represents the expected interaction between structural elements of an architecture as a sequence of message exchanges.	Use sequence diagrams to describe how the parts of a system interact.	Describe System Behavior Using Sequence Diagrams
lifeline	A lifeline is represented by a head and a timeline that proceeds down a vertical dotted line.	The head of a lifeline represents a component in an architecture model.	Add Lifelines and Messages
message	A message sends information from one lifeline to another. Messages are specified with a message label.	A message label has a trigger, an optional guard, and an optional constraint where a trigger represents the identifying event for this message, a guard represents an additional condition to determine whether the message occurs, and a constraint is an expression that is expected to be true when this message occurs.	Create Messages in Sequence Diagram
gate	A gate represents the root architecture of the corresponding architecture model.	Connect messages to gates to represent architecture ports.	Create Sequence Diagram Gates
annotation	An annotation describes the elements of a sequence diagram.	Use annotations to provide detailed explanations of elements or workflows captured by sequence diagrams.	Use Annotations to Describe Elements of Sequence Diagram
fragment	A fragment indicates how a group of messages execute or interact.	A fragment is used to model complex sequences, such as alternatives, in a sequence diagram.	Author Sequence Diagram Fragments
operand	An operand is a region in a fragment. Fragments have one or more operands depending on the kind of fragment. Operands can contain messages and additional fragments.	Each operand can include a constraint to specify whether the messages inside the operand execute. You can express the precondition of an operand as a MATLAB® Boolean expression using the input signal of a lifeline.	Add Fragments and Operands

Version History

Introduced in R2024b