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

生成系统架构报告

您可以使用 System Composer™ 和 Simulink® Report Generator™ 来设计和生成包含架构设计信息和工件的报告。您可以交互式和编程方式自定义系统架构报告，以最好地满足利益相关者的格式和内容需求。

使用报告生成类，通过自定义报告将从 System Composer 架构模型捕获的架构设计数据导出为 PDF、DOCX 和 HTML 文件格式。使用查找器、结果和报告器等报告组件动态生成报告内容。需要 Simulink Report Generator 许可证才能生成报告。

有关生成 Simulink 模型报告的更多信息，请参阅创建 Simulink Report Generator 报告 (Simulink Report Generator)。

架构模型的报告生成工作流

使用系统架构报告工具和 Report API 类查找架构元素并报告设计情况。您可以使用报告属性来过滤和格式化结果。

报告结构

报告是一个类型为 slreportgen.report.Report (Simulink Report Generator) 的容器对象，用于保存报告。您可以向报告添加各种文档元素，例如标题页、目录、章节和部分。有关这些功能的更多信息，请参阅标题页、目录、图窗、表和题注列表 (MATLAB Report Generator)。

例如，此目录页面来自生成的报告。

Table of contents page from a system architecture report.

除了文档元素和结构外，报告还包含与架构模型相关的内容。要生成特定内容，可以添加报告组件来创建报告生成器，该生成器可查找并报告 System Composer 架构模型元素。

架构模型的报告组件

组件决定了报告的行为和内容。使用与 System Composer 集成的系统架构报告，您可以生成包含以下架构元素的设计信息的报告：

  • 分配集和列表

  • 组件

  • 连接器

  • 字典

  • 函数

  • 接口

  • 配置文件

  • 需求集和链接集

  • 序列图

  • 构造型

  • 视图

通常，每个报告组件都有一个查找器类、一个结果类和一个报告器类。有关详细信息，请参阅使用 System Composer 报告生成 API。

使用系统架构报告

使用系统架构报告工具，您可以：

  • 浏览并选择架构模型，以生成包含多个架构模型的综合报告。

  • 创建和管理自定义报告模板。

  • 选择要包含在报告中的章节、自定义章节描述以及要包含的架构元素属性，以此来定义报告内容。

  • 将报告保存为 PDF、DOCX 和 HTML 格式，导出架构数据。

System Architecture Report tool

使用 System Composer 报告生成 API

存储在 systemcomposer.rptgen 命名空间中的 System Composer 报告生成 API 包括查找和格式化架构模型数据的对象。您可以将这些对象与 MATLAB® 报告 API 和 DOM API 对象一起使用，创建 MATLAB 程序，以生成关于 System Composer 架构模型的报告。

您可以使用 Simulink 报告构造函数 slreportgen.report.Report (Simulink Report Generator) 创建一个报告对象来保存报告的内容。

您可以使用报告组件查找器、结果和报告器将特定于每个架构模型的内容添加到报告中。

  • 查找器 - 在给定的架构模型中查找特定元素，例如组件或构造型。

  • 结果 - 包含与查找器对象的结果相对应的数组。查找器返回的每个结果对象都有一个相关的报告器对象。

  • 报告器 - 保存内容并格式化内容。您将报告器对象添加到报告中。

每个报告 API 页都提供了详细示例，说明如何使用提供的查找器、结果和报告器类。

架构元素描述查找器结果报告器
分配清单报告给定分配集文件中的分配情况。systemcomposer.rptgen.finder.AllocationListFindersystemcomposer.rptgen.finder.AllocationListResultsystemcomposer.rptgen.report.AllocationList
分配集分配集报告。systemcomposer.rptgen.finder.AllocationSetFindersystemcomposer.rptgen.finder.AllocationSetResultsystemcomposer.rptgen.report.AllocationSet
组件报告给定架构模型中的组件。systemcomposer.rptgen.finder.ComponentFindersystemcomposer.rptgen.finder.ComponentResultsystemcomposer.rptgen.report.Component
连接器报告给定架构模型中的连接器。systemcomposer.rptgen.finder.ConnectorFindersystemcomposer.rptgen.finder.ConnectorResultsystemcomposer.rptgen.report.Connector
字典报告给定架构模型中的数据字典。systemcomposer.rptgen.finder.DictionaryFindersystemcomposer.rptgen.finder.DictionaryResult–
函数报告给定软件架构模型中的函数。systemcomposer.rptgen.finder.FunctionFindersystemcomposer.rptgen.finder.FunctionResultsystemcomposer.rptgen.report.Function
接口报告给定架构模型中的接口。systemcomposer.rptgen.finder.InterfaceFindersystemcomposer.rptgen.finder.InterfaceResultsystemcomposer.rptgen.report.Interface
配置文件报告给定架构模型中的配置文件。systemcomposer.rptgen.finder.ProfileFindersystemcomposer.rptgen.finder.ProfileResultsystemcomposer.rptgen.report.Profile
需求链接报告给定需求链接集文件（.slmx 文件）中的需求链接。systemcomposer.rptgen.finder.RequirementLinkFindersystemcomposer.rptgen.finder.RequirementLinkResultsystemcomposer.rptgen.report.RequirementLink
需求集报告给定需求集文件（.slreqx 文件）中的需求。systemcomposer.rptgen.finder.RequirementSetFindersystemcomposer.rptgen.finder.RequirementSetResultsystemcomposer.rptgen.report.RequirementSet
序列图报告给定序列图。––systemcomposer.rptgen.report.SequenceDiagram
构造型报告给定配置文件中的构造型。systemcomposer.rptgen.finder.StereotypeFindersystemcomposer.rptgen.finder.StereotypeResultsystemcomposer.rptgen.report.Stereotype
视图报告给定架构模型中的视图。systemcomposer.rptgen.finder.ViewFindersystemcomposer.rptgen.finder.ViewResultsystemcomposer.rptgen.report.View

有关更多信息，请参阅使用 System Composer 报告 API 生成系统架构报告和使用 System Composer 报告 API 为软件架构生成系统架构报告。

另请参阅

工具

类

主题