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

系统设计描述

预定义标准报告

从 Simulink® 工具条中，您可以生成两个预定义的标准 Simulink Report Generator™ 报告，分别称为：

  • 系统设计描述

  • 系统需求可追溯性

系统设计描述报告提供有关模型所代表的系统设计的摘要或详细信息。您可以使用报告对话框选择报告选项，也可以使用报告资源管理器创建自定义版本。有关详细信息，请参阅生成系统设计描述报告。

您可以使用系统设计描述报告设置文件作为创建您自己的报告设置文件的起点。有关详细信息，请参阅打印模型报告。

系统需求可追溯性报告要求您安装 Requirements Toolbox™。系统需求可追溯性报告包括与模型及其对象相关的所有需求的信息。

按照以下步骤从 Simulink 工具条生成系统需求可追溯性报告：

  1. 如果需求选项卡不可用，请在 App 选项卡的模型验证、确认和测试部分中点击需求管理器。

  2. 在需求选项卡的共享部分中，点击共享 > 生成模型可追溯性报告。

系统设计描述是什么？

系统设计描述是一个预先构建的 Simulink Report Generator 报告，它描述了由 Simulink 模型表示的系统设计。

默认情况下，Simulink Report Generator 会为您调用系统设计描述报告选项的模型生成报告。

您可以使用报告做什么

您可以使用系统设计描述来

  • 无需打开模型即可查看系统设计

  • 生成设计的摘要和详细描述

  • 评估是否符合设计需求

  • 以独立于建模环境的格式存档系统设计

  • 使用报告资源管理器构建报告的自定义版本

报告内容

您可以指定报告中要包含哪些类型的信息，包括：

  • 报告中应包含模型的哪些元素（例如，是否包含自定义库中的子系统）

  • 通过选择 设计详细信息 检查框，决定生成系统设计描述报告的摘要版本还是详细版本。

有关详细信息，请参阅生成系统设计描述报告。

摘要版本

报告摘要包括以下部分：

节信息
报告概述

模型版本

根系统

  • 表示计算根系统输出的算法的模块图快照

    注意

    模块图快照仅在模型显示此信息时显示信号采样时间、数据类型和维度。要显示此信息，在模型中的调试选项卡中的诊断部分，展开叠加信息，然后选择颜色、基本数据类型和信号维度。

  • 描述

  • 注释 (自 R2025a 起)

  • 接口：系统输入和输出信号的名称、数据类型和其他属性

  • Stateflow 图，包括：

    • Stateflow 图快照

    • 注释 (自 R2025a 起)

子系统

  • 根系统部分中的信息

  • 模型中子系统的路径

系统设计变量

  • 设计变量

  • 设计变量表达式中的函数

需求

  • 模型信息

  • 模型中链接的要求文档的文档摘要

详细版本

报告的详细版本包括报告摘要形式的所有信息，以及有关系统组件的详细信息。

节信息
报告概述

模型版本

根系统

  • 表示计算根系统输出的算法的模块图快照

    注意

    模块图快照仅在模型显示此信息时显示信号采样时间、数据类型和维度。要显示此信息，在模型中的调试选项卡中的诊断部分，展开叠加信息，然后选择颜色、基本数据类型和信号维度。

  • 描述

  • 注释 (自 R2025a 起)

  • 接口：根系统输入和输出信号的名称、数据类型和其他属性

  • 模块

    • 模块参数

    • 有关 MATLAB Function 模块的详细信息

    • 根系统和原子子系统的模块执行顺序

  • 查找表

  • Simulink 工作区变量

  • 模型配置集

  • Stateflow 图，包括：

    • Stateflow 图快照

    • 注释 (自 R2025a 起)

    • 状态

    • 状态之间的转移

    • 结点

    • 触发状态转移的事件

    • 数据类型

    • 目标

    • 真值表

子系统

与根系统相同的信息，以及：

  • 模型中子系统的路径

  • 引用模型

  • 来自自定义库的子系统

  • 对于原子子系统，指示生成报告的原子子系统的版本是否与该子系统的其他版本不同的校验和。

系统设计变量

  • 设计变量

  • 设计变量表达式中的函数

  • 枚举类型

需求

  • 模型信息

  • 模型中链接的要求文档的文档摘要

报告捕获模型中包含的文档

系统设计描述报告模型中包含的文档，包括：

  • 模型描述（来自模型属性）

  • 模块属性 Description

  • DocBlock 模型文档模块

为了丰富生成的系统设计描述，在模型中添加相应的信息。