本页采用了机器翻译。点击此处可查看最新英文版本。

systemcomposer.rptgen.report.SequenceDiagram 类

命名空间: systemcomposer.rptgen.report
超类: slreportgen.report.Reporter (Simulink Report Generator)

序列图报告器

自 R2022b 起

全页展开

描述

创建一个报告器，报告 System Composer™ 架构模型中的序列图。

systemcomposer.rptgen.report.SequenceDiagram 类是 handle 类。

创建对象

reporter = SequenceDiagram("Name",name,"ModelName",model) 创建了一个报告器，使用名称和模型名称对序列图进行报告。

属性

全部展开

序列图的名称，指定为字符串。

数据类型: string

不带 .slx 扩展名的架构模型文件名，指定为字符串。

数据类型: string

自定义快照报告器，指定为报告器对象。默认值为 slreportgen.report.Diagram (Simulink Report Generator) 报告器。

此报告器的模板来源，以下列方式之一指定：

  • 指定此报告器模板文件路径的字符向量或字符串标量

  • 此报告器所用模板的源报告器或报告（或其模板库包含此报告器的模板）

  • 此报告器所用模板的文档对象模型 (DOM) 文档或文档部件（或其模板库包含此报告器的模板）

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft® Word 报告，TemplateSrc 必须是 Word 报告器模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

此报告器的模板名称，指定为字符向量或字符串标量。该报告器的模板必须位于该报告器的 TemplateSrc 属性指定的模板的模板库中。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget (MATLAB Report Generator) 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标在输出报告中紧接着此报告器的内容。

属性：

GetAccess
public
SetAccess
public

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

使用 SequenceDiagram 报告器类创建包含给定架构模型中所有序列图的报告。

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

打开 TLExample 模型。

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

创建一个报告，并追加标题页和目录。

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

创建一个章节，包含架构模型中与序列图相关的所有部分。

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

使用 systemcomposer.arch.Model.Interactions 属性查找架构模型中的所有序列图。

interactions = mdl.Interactions;

为 interactions 数组中的每个 Interaction 对象创建一个部分。

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(sequenceDiagramsReport,chapter);
close(sequenceDiagramsReport);
rptview(sequenceDiagramsReport);

版本历史记录

在 R2022b 中推出

另请参阅

工具

类

主题