当你选择创建代码生成报告选项为基于ert的模型代码接口报告节将自动包含在生成的HTML报告中。的代码接口报告节为生成代码的使用者提供生成代码接口的文档,包括模型入口点函数和接口数据。报告中的信息可以帮助促进代码审查和代码集成。
代码接口报告包括以下小节:
入口点函数-关于每个模型入口点功能的接口信息,包括model_initialize
,model_step
,及(如适用)model_reset
和model_terminate
.
港口和外港-每个模型导入和输出端口的接口信息。
接口参数-与模型相关的可调参数的接口信息。
数据存储-全局数据存储和非-的数据存储的接口信息汽车
与模型关联的存储。
有关应用于代码接口报告的限制,请参见代码接口报告的局限性.
为便于说明,本节使用以下模型:
rtwdemo_configinterface
(ExportedGlobal存储类在模型窗口中选择的按钮),以查看报表子部分的示例
rtwdemo_mrmtbb
例如时间信息
rtwdemo_fcnprotoctrl
有关函数参数和返回值信息的示例
要为您的模型生成代码接口报告:
打开你的模型,去代码生成窗格中,选择ert.tlc
或者一个ERT-based系统目标文件,如果尚未选择。
去代码生成>报告窗格,并选择该选项创建代码生成报告,如果尚未选中。的rtwdemo_configinterface
,rtwdemo_mrmtbb
,rtwdemo_fcnprotoctrl
本节中使用的模型选择多个报告默认情况下窗格选项。但是选择只有创建代码生成报告,生成一个代码接口报告部分。
或者,您可以通过发出下面的MATLAB以编程方式选择该选项®命令:
set_param (bdroot“GenerateReport”,“上”)
如果Code-to-model参数,生成的报告将包含到模型的超链接。保留此值,除非您计划在MATLAB环境之外使用该报告。
构建的模型。如果您选择报告窗格中选择自动打开报告,则代码生成报告在构建过程完成后自动打开。(否则,您可以从模型构建文件夹中手动打开它。)
要显示模型的代码接口报告,请转到内容窗格,然后单击代码接口报告链接。例如,这里是为模型生成的代码接口报告rtwdemo_configinterface
(ExportedGlobal存储类在模型窗口中选中的按钮)。
有关导航代码接口报告子节内容的帮助,请参见导航代码接口报告子部分.要了解代码接口报告子部分的内容,请参阅下面的部分对入口点功能部分的解释.
为了帮助您浏览代码接口描述,代码接口报告提供了折叠/展开令牌和超链接,如下所示:
对于一个大的分段,报告提供了[,]
和[+]
允许您折叠或展开该部分的符号。在上一节的示例中,为港口和接口参数部分。
代码接口报告中提供了几种超链接导航形式。例如:
的表的内容位于代码接口报告的顶部,提供了到每个分段的链接。
单击每个函数名可以查看其定义
.模型
.c
您可以单击每个函数的头文件名以进入头文件源清单。
如果您选择Code-to-model参数,要进入模型显示中相应的位置,可以单击以下任何一个超链接:
函数参数
函数返回值
轮廓尺寸
外港
接口参数(如果参数源是一个块)
数据存储(当数据源为数据存储内存块)
要在HTML代码生成报告中进行向后和向前导航,请使用回来和向前上面的按钮内容部分在报告的左上角。
的入口点函数代码接口报告的小节提供了以下关于每个模型入口点功能的接口信息,包括model_initialize
,model_step
,及(如适用)model_reset
和model_terminate
.
场 | 描述 |
---|---|
功能: | 列出函数名。单击函数名可以转到函数的定义 . |
原型 | 显示函数原型,包括函数返回值、名称和参数。 |
描述 | 提供函数在应用程序中的用途的文本描述。 |
时机 | 描述函数的计时特性,例如函数被调用的次数,或者是否周期性地调用,以及以什么时间间隔调用。有关多速率定时示例,请参见下面rtwdemo_mrmtbb 报告摘录。 |
参数 | 如果函数有参数,则显示数字、名称、数据类型和Simulink金宝app®每个参数的描述。如果您选择Code-to-model参数,您可以单击描述中的超链接以转到与模型显示中的参数对应的块。有关参数的示例,请参见rtwdemo_fcnprotoctrl 报告摘录如下。 |
返回值 | 如果函数有返回值,该字段显示返回值数据类型和Simulink描述。金宝app如果您选择Code-to-model参数,您可以单击描述中的超链接以转到与模型显示的返回值对应的块。有关返回值示例,请参见下面rtwdemo_fcnprotoctrl 报告摘录。 |
头文件 | 列出函数头文件的名称。您可以单击头文件名称以进入头文件源清单。 |
例如,这里是入口点函数模型的分段rtwdemo_configinterface
.
为了说明如何为多费率模型列出时间信息,下面是入口点函数和港口模型的子部分rtwdemo_mrmtbb
.这个多速率、离散时间、多任务模型包含import块1和2,分别指定1秒和2秒的采样时间。属性将样本时间限制为指定的时间周期性样本时间约束选择在解算器对话框中的。
为了说明函数参数和返回值是如何在报告中显示的,下面是模型的模型步骤函数的入口点函数描述rtwdemo_fcnprotoctrl
.
的港口和外港代码接口报告的子部分提供了以下关于模型中每个导入和输出的接口信息。
场 | 描述 |
---|---|
块名称 | 显示导入或输出端口的Sim金宝appulink块名称。如果您选择Code-to-model参数,您可以单击每个导入或输出端口块名称值将转到其在模型显示中的位置。 |
代码标识符 | 在生成的代码中列出与导入或输出数据关联的标识符,如下所示:
|
数据类型 | 列出导入或输出端口的数据类型。 |
扩展 | 对于定点条目,使用Simulink定点数据类型表示法列出数据类型和分数长度。金宝app 请注意 您必须具有定点设计器™许可证才能在报告中查看定点缩放信息。有关表中如何表示缩放的更多信息,请参见定点数据类型和缩放符号(定点设计师). |
维 | 列出导入或输出的维度(例如,1 或(4、5) ). |
例如,这里是港口和外港模型的子部分rtwdemo_configinterface
.
的接口参数代码接口报告的小节提供了以下与模型相关的可调参数的接口信息。
场 | 描述 |
---|---|
参数来源 | 列出参数值的来源,如下所示:
|
代码标识符 | 在生成的代码中列出与可调参数数据关联的标识符,如下所示:
|
数据类型 | 列出可调参数的数据类型。 |
扩展 | 对于定点条目,使用Simulink定点数据类型表示法列出数据类型和分数长度。金宝app 请注意 您必须具有定点设计器许可证才能在报告中查看定点缩放信息。有关表中如何表示缩放的更多信息,请参见定点数据类型和缩放符号(定点设计师). |
维 | 列出可调参数的维度(例如,1 或(4、5、6) ). |
例如,这里是接口参数模型的分段rtwdemo_configinterface
(ExportedGlobal存储类在模型窗口中选中的按钮)。
的数据存储代码接口报告小节提供了以下关于全局数据存储和非数据存储的接口信息汽车
与模型关联的存储。
场 | 描述 |
---|---|
数据存储源 | 列出数据存储内存的来源,如下所示:
|
代码标识符 | 在生成的代码中列出与数据存储数据关联的标识符,如下所示:
|
数据类型 | 列出数据存储的数据类型。 |
扩展 | 对于定点条目,使用Simulink定点数据类型表示法列出数据类型和分数长度。金宝app 请注意 您必须具有定点设计器许可证才能在报告中查看定点缩放信息。有关表中如何表示缩放的更多信息,请参见定点数据类型和缩放符号(定点设计师). |
维 | 列出数据存储的维度(例如,1 或[1,2] ). |
例如,这里是数据存储模型的分段rtwdemo_configinterface
(ExportedGlobal存储类在模型窗口中选中的按钮)。
以下限制适用于HTML代码生成报告的代码接口部分。
代码接口报告不支持带有ERT目标或金宝appc++类包装代码接口。对于这些配置,代码接口报告不会生成,也不会出现在HTML代码生成报告中内容窗格。
代码接口报告支持大多数存储类解析的数据,除非存储类的金宝app属性是通过以下方式设置的:
存储类属性类型被设置为FlatStructure
.例如,设置
和结构体
在Simulink包中的存储类金宝app类型设置为FlatStructure
.
存储类属性类型被设置为其他
.例如,GetSet
在Simulink包中的存储类金宝app类型设置为其他
.
存储类属性数据访问被设置为指针
,表示导入的符号声明为指针变量而不是简单变量。此属性仅在存储类属性时可访问数据范围被设置为进口
或特定于
.
在这些情况下,报告显示为空数据类型和维字段。
对于输出端口,如果内存进行了优化,则代码接口报告无法描述相关的内存(数据类型和维度)。在这些情况下,报告显示为空数据类型和维字段。
的代码接口报告不支持数据类型替换金宝app代码生成>数据类型替换对话框中的。报告中列出的数据类型将链接到内置数据类型,而不是它们指定的替换数据类型。