systemcomposer.rptgen.report.SequenceDiagram Class

Namespace: systemcomposer.rptgen.report
Superclasses: slreportgen.report.Reporter (Simulink Report Generator)

Sequence diagram reporter

Since R2022b

Description

Create a reporter that reports on a sequence diagram in a System Composer™ architecture model.

The systemcomposer.rptgen.report.SequenceDiagram class is a handle class.

Creation

reporter = SequenceDiagram("Name",name,"ModelName",model) creates a reporter that reports on a sequence diagram using the name and model name.

Properties

Name — Name of sequence diagram

string

Name of sequence diagram, specified as a string.

Data Types: string

ModelName — Architecture model file name

string

Architecture model file name without the .slx extension, specified as a string.

Data Types: string

Snapshot — Custom snapshot reporter

reporter object

Custom snapshot reporter, specified as a reporter object. The default value is the slreportgen.report.Diagram (Simulink Report Generator) reporter.

TemplateSrc — Source of template for this reporter

character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

TemplateName — Name of template for this reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget (MATLAB Report Generator) object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

createTemplate	Create sequence diagram template
customizeReporter	Create custom sequence diagram reporter class
getClassFolder	Sequence diagram class definition file location

Inherited Methods

copy (Simulink Report Generator)	Create copy of a Simulink® reporter object and make deep copies of certain property values
getImpl (Simulink Report Generator)	Get implementation of reporter

Examples

Find Sequence Diagrams in Architectures

Use the SequenceDiagram reporter class to create a report that includes all sequence diagrams in a given architecture model.

import mlreportgen.report.*
import slreportgen.report.*
import systemcomposer.rptgen.report.*

Open the TLExample model.

model_name = "TLExample";
mdl = systemcomposer.loadModel(model_name);

Create a report and append a title page and table of contents.

sequenceDiagramsReport = slreportgen.report.Report(OutputPath=model_name + "_SequenceDiagramsReport", ...
    CompileModelBeforeReporting=false);
append(sequenceDiagramsReport,TitlePage(Title="Sequence Diagrams in " + model_name));
append(sequenceDiagramsReport,TableOfContents);

Create a chapter to contain all sections related to sequence diagrams in the architecture model.

chapter = Chapter(Title="Sequence Diagrams");

Use the systemcomposer.arch.Model.Interactions property to find all sequence diagrams in the architecture model.

interactions = mdl.Interactions;

Create a section for each Interaction object in the interactions array.

for i=1:length(interactions)
    name = interactions(i).Name;
    interactionSection = Section(Title=name);
    reporter = SequenceDiagram(Name=name, ModelName=model_name);
    append(interactionSection,reporter);
    append(chapter,interactionSection);
end

Append the chapter to the report and view the generated report.

append(sequenceDiagramsReport,chapter);
close(sequenceDiagramsReport);
rptview(sequenceDiagramsReport);

Version History

Introduced in R2022b