addInteraction

Create new sequence diagram in model

Since R2024b

collapse all in page

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.

example

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

Examples

collapse all

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

collapse all

`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

collapse all

`interaction` — Interaction
interaction object

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

More About

collapse all

Definitions

Term	Definition	Application	More Information
Interaction	An interaction specifies how each part of a system should interact as a sequence of message exchanges.	Use interactions to describe operational system behaviors.	Describe System Behavior Using Sequence Diagrams
Sequence diagram	A sequence diagram is a visual representation of an interaction.	Use sequence diagrams to visually specify how each part of a system should interact.	Describe System Behavior Using Sequence Diagrams
Lifeline	A lifeline represents an instance of a component as a participant of an interaction.	A lifeline corresponds to a component in an architecture.	Describe Interactions with Lifelines and Messages
Message	A message represents communication between two lifelines. Messages have labels to specify the expected condition for the message to occur.	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.	Describe Interactions with Lifelines and Messages
Gate	A gate represents the root of an architectural hierarchy.	A gate allows you to describe the exchange of messages between the architecture and its environment.	Describe Interactions with Lifelines and Messages
Annotation	An annotation describes the elements of a sequence diagram.	Use annotations to provide detailed explanations of elements or workflows captured by sequence diagrams.	Annotate Sequence Diagrams with Annotations
Fragment	A fragment encloses a group of lifelines and messages within an interaction to allow for the specification of more complex patterns of interaction.	A fragment defines the type of ordering logic such as looping and alternatives. Fragments can have one or more operands.	Model Complex Interactions with Fragments and Operands
Operand	An operand is a region in a fragment, or group of messages. The condition of an operand specifies whether the messages inside the operand execute.	The condition of an operand can specify constraints on the input signal of a lifeline as a MATLAB^® Boolean expression.	Model Complex Interactions with Fragments and Operands
Duration constraint	A duration constraint defines a constraint on elapsed time between a start and an end occurrence.	Use duration constraints to explicitly express a constraint on the duration between a start occurrence and an end occurrence.	Specify Timing Constraints Between Message Events with Duration Constraints

Version History

Introduced in R2024b

addInteraction

Syntax

Description

Examples

Create New Sequence Diagram

Input Arguments

`model` — Architecture model
model object

`name` — Name of interaction
character vector | string

`copyFrom` — Interaction to copy from
interaction object

Output Arguments

`interaction` — Interaction
interaction object

More About

Definitions

Version History

See Also

Tools

Functions

Objects

Topics

addInteraction

Syntax

Description

Examples

Create New Sequence Diagram

Input Arguments

model — Architecture model model object

name — Name of interaction character vector | string

copyFrom — Interaction to copy from interaction object

Output Arguments

interaction — Interaction interaction object

More About

Definitions

Version History

See Also

Tools

Functions

Objects

Topics

`model` — Architecture model
model object

`name` — Name of interaction
character vector | string

`copyFrom` — Interaction to copy from
interaction object

`interaction` — Interaction
interaction object