findLifeline

Find lifeline in interaction

Since R2024b

Syntax

lifelines = findLifeline(interaction,Name=Value)

Description

lifelines = findLifeline(interaction,Name=Value) uses the name or path to find lifelines in a sequence diagram that correspond to the interaction interaction.

Examples

Create New Sequence Diagram with Lifeline and Find Lifeline

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

Add a lifeline to the sequence diagram.

lifeline = interaction.addLifeline(comp);

Find a lifeline by name in the sequence diagram.

lifelineFound = interaction.findLifeline(Name="Component")

lifelineFound = 

  Lifeline with properties:

               Name: 'Component'
           FullPath: 'archModel/Component'
             Parent: [0×0 systemcomposer.interaction.Lifeline]
           Children: [0×0 systemcomposer.interaction.Lifeline]
    RelatedElements: [1×1 systemcomposer.arch.Component]
               UUID: '6e96667a-c5a9-4480-90cc-808f6ebd46e4'
        ExternalUID: ''

Input Arguments

interaction — Interaction

interaction object

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

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: findLifeline(interaction,Name="Component")

Name — Name of lifelines

character vector | string

Name of lifelines, specified as a character vector or string. Multiple lifelines at different hierarchical levels can all share the same name.

Example: findLifeline(interaction,Name="Component")

Data Types: char | string

Path — Path of lifeline

character vector | string

Path of lifeline, specified as a character vector or string.

Example: findLifeline(interaction,Path="GrandParent/Parent/Child")

Data Types: char | string

Output Arguments

lifelines — Lifelines

lifeline object | array of lifeline objects

Lifelines, returned as a systemcomposer.interaction.Lifeline object or array of systemcomposer.interaction.Lifeline objects.

More About

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