Main Content

systemcomposer.rptgen.report.SequenceDiagram Class

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

Sequence diagram reporter

Since R2022b

expand all in page

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

expand all

Name of sequence diagram, specified as a string.

Data Types: string

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

Data Types: string

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

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 is used for this reporter or whose template library contains the template for this reporter

  • Document Object Model (DOM) document or document part whose template is used for this reporter 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.

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.

Data Types: char | string

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.

Methods

expand all

Version History

Introduced in R2022b

See Also

Classes

Topics