目录
前言
同C代码通过工具生成软件详细设计,模型开发也可通过工具导出详细设计。
MATLAB有单独用于生成软件详细设计的工具包Simulink Report Generator,奈何暂时买不起,所以自己研究了一下,退而求其次,用matlab的print功能导出详细设计,要求不高勉强够用,本文就介绍了一下print如何导出及报告的内容。
工具包Simulink Report Generator我也还没机会使用,根据基本了解,我在下方列出两种方式的对比
Simulink Report Generator
1、生成详设(System Design Description Report.),doc格式,可自定义详设包含的内容。与当前自带print功能相比,print生成HTML model report,只能导出HTML格式文件,且格式和内容固定不能自编辑,并会显示模型图,不适合作为详细设计对外释放
2、生成需求追溯文件。需要安装 Simulink Requirements工具包配合使用。
本系列下文将介绍一种推荐的模型注释格式,以通过print方法导出的详细设计内容完整,符合ASPICE ,且看起来简洁条理。
1、导出模型软件详细设计的配置:
1、在Simulink Editor中,在Simulation选项卡上,择Print>Print Details
2、Print Details对话框如下所示
为导出模型详细设计说明书,建议勾选一下几项:
- 勾选Directory > other,文件存放位置自己指定路径。
- 勾选Increment filename to prevent overwriting old files,为每个报告生成一个单独的报告名,便于管理。
- 勾选Entire model,选择为整个模型生成报告。
- 勾选Look under mask dialog,选择在报告中包括封装子系统的内容。
- 勾选Expand unique library links,选择在报告中包括以子系统形式存在的库模块的内容。在报告中,一个库子系统只包括一次,即使它出现在模型中多个位置也是如此。
3、点击 Print
Simulink 软件将生成 HTML 报告,并在您的默认 HTML 浏览器中显示该报告。
生成报告时,Simulink 将在消息窗格(取代 Print Details 对话框中的选项窗格)中显示状态消息。
生成报告完毕后,点击Options 按钮将重新显示报告生成选项,允许您生成另一个报告,而无需重新打开 Print Details 对话框。
2、导出的详细设计报告的内容:
- 报告中包含模型的模块图、子系统和模块参数设置
以下以一个demo介绍报告中的内容
1)报告中首先会显示模型名称及顶层模型。显示报告生成人员及时间。
2)以下为报告目录
3)table of contents按照模型从上往下的各个层级,分别进行介绍,列出其中输入输出变量的属性。
- 模型顶层:
- 模型中间层:
- 模型底层详细逻辑:
- 报告中统计simulink各基础模块的个数:
- 报告中统计stateflow中各状态及状态迁移的个数:
- 报告中统计接口变量和局部变量的数据类型及变量定义的位置指引: