slreportgen.report.MATLABFunction类

包:slreportgen.report
超:

MATLAB功能块或Stateflow的MATLAB记者函数

描述

创建一个MATLAB功能块或状态流®MATLAB®功能记者。

注意

要使用MATLABFunction记者在一份报告中,您必须使用创建报告slreportgen.report.Report类。

施工

记者= MATLABFunction()创建一个空MATLABFunction基于默认模板记者。使用其属性来指定的Simulink金宝app®MATLAB功能阻止或在其上Stateflow的MATLAB功能报告并指定报告选项。

记者= MATLABFunction(mlfcnobj创建MATLABFunction记者指定的mlfcnobj。记者会将此默认信息生成的报告:

  • 金宝appMATLAB功能块属性或状态流MATLAB函数特性,这取决于是否MATLAB函数是一个块或对象

  • 函数的输入和输出参数总结

  • 由MATLAB函数中使用MATLAB代码来计算其输出来自其输入端

使用报告性质包括其他信息,诸如详细的参数的属性,功能符号属性,和支持功能的信息。金宝app

记者= MATLABFunction(名称,值MATLABFunction使用名称 - 值对记者特性。您可以按任意顺序指定多个名称 - 值对的参数。用单引号或双引号中每个属性的名称。

输入参数

展开全部

查看宾语属性。

属性

展开全部

金宝appSimulink的MATLAB函数块或状态流MATLAB函数,其属性以报告,指定为路径或手柄。

注意

如果使用取景器找到一个查找表块,并直接将其添加到报表中,这LookupTable中记者使用,而不是Simulink的对象属性的记者。金宝app

是否包含对象属性,指定为逻辑。如果真正,该报告包括MATLAB功能的属性表。如果,不包括在属性表。

对象属性记者,指定为BaseTable记者或自定义报告。该MATLABFunction记者使用指定的记者创造了MATLAB函数的性质的表。要报告的性质取决于MATLAB函数是否是一个Simulink的金宝appMATLAB功能块或Stateflow的MATLAB函数。

对于MATL金宝appAB的Simulink功能块,这些性质报告:

  • 更新方法

  • 采样时间

  • 金宝app支持可变大小的数组

  • 饱和整数溢出

  • 治疗这些遗传Simulink的信号类型作为网金宝app络连接目的

  • MATLAB功能块fimath

  • 输入网络数学

  • 描述

对于Stateflow的MATLAB功能,这些性质报告:

  • 饱和整数溢出

  • MATLAB功能fimath

  • 输入网络数学

  • 描述

要自定义功能属性表的外观和它的标题,定制默认BaseTable记者或者用的自定义版本来替换它BaseTable记者。要自定义功能属性表的标题,指定的内容标题默认或替换记者的财产。您指定的内容被放置在默认标题的前面。

是否包括一个参数汇总表,指定为逻辑。如果真正,该报告包括的参数特性的汇总表MATLAB功能。如果,该报告不包括参数汇总表。

参数性能在包括MATLAB功能参数汇总表,指定为属性名字符向量的单元阵列。包括在总结的默认属性名称范围港口编译类型Compiiled大小。如果模型尚未编译时,MATLABFunction记者编译模式获得编译类型编译的大小数据。当报告被关闭,该模型是未编译。

此属性的值可以是任意组合MATLAB功能参数性能。

  • 名称

  • 范围

  • 港口

  • 编译类型(数据类型)

  • 编译(尺码)

  • 复杂

  • 描述

  • 最大(Max值)

  • 最小(最小值)

  • 可调

  • 大小可变

参数汇总记者,指定为BaseTable记者或自定义报告。该MATLABFunction记者使用指定的记者创造的MATLAB函数的参数表。该表包括的参数的摘要和由指定的参数的属性ArgumentSummaryProperties

定制参数汇总表的外观和它的标题的内容,定制默认BaseTable记者或者用的自定义版本来替换它BaseTable记者。

是否包括具有用于每个参数的详细信息,指定作为逻辑的属性表。如果,该报告不包括在MATLAB函数每个参数属性表。如果真正,该报告包括属性表,如果模型尚未编译时,MATLABFunction记者编译模型。当报告被关闭,该模型是未编译。

参数特性记者,指定为BaseTable记者或自定义报告。该MATLABFunction记者使用指定的记者创造了MATLAB函数的参数属性表。该MATLABFunction记者创建并使用记者的副本要报告每个参数属性。

定制参数属性表的外观,定制默认BaseTable记者或者用的定制版本来替换它BaseTable记者。

是否包括功能脚本,指定为逻辑。如果真正,该报告包括MATLAB函数脚本计算的输出MATLAB功能从它的输入框。如果该报告不包括功能脚本。

功能脚本代码格式,指定为mlreportgen.dom.Paragraph段。要自定义功能的脚本格式,如字体,字体大小,对齐和其他属性,设置其mlreportgen.dom.Paragraph属性。该mlreportgen.dom.Paragraph不控制记者是否使用颜色来突出显示脚本语法。查看HighlightScriptSyntax控制高亮。

要自定义脚本的外观,修改默认段落的属性,或更换另一个段落对象的段落。如果将内容添加到默认或更换款,这些内容被放置在生成的报告中功能的MATLAB脚本之前。

功能脚本名称,指定为mlreportgen.dom.Paragraph,其中包含标题包含MATLAB函数脚本的部分。默认的标题是MATLAB功能块名,后跟被附加到该段落“函数脚本”。例如,对于一个名为MATLAB功能块“协方差衍生”的标题是“协方差导函数脚本。”该段的属性指定脚本标题的外观。

要自定义标题外观,修改默认段落对象的属性或与另一款物代替它。如果将内容添加到默认或更换标题段落,您指定的内容被放置在默认标题的前面。

亮点脚本语法关键字,指定为逻辑。如果真正该报告使用颜色来突出显示脚本语法关键字。如果,该报告并不突出的关键字。

是否包括功能符号数据,指定为逻辑。

如果,该报告不包括约出现在主要功能的MATLAB脚本中的符号信息。如果真正,所述报告包括所述符号数据的信息。如果Include金宝appSupportingFunctions属性也真正该报告还包含与出现在支持功能的符号信息。金宝app功能符号数据报告只有当源宾语本报记者的属性是Simulink的金宝appMATLAB功能块。

注意

如果包含函数符号数据,生成报表可能慢于如果你不包括它。

功能符号数据报告,指定为mlreportgen.report.BaseTable。记者是报告出现在MATLAB功能的主脚本符号性质的基础。所生成的报告的符号由类型,其是可变的,操作和功能调用点分组。列出每个符号类型的功能性后,将出现表。符号表列出了出现在主功能或特定功能的支持特定类型的所有符号。金宝app该报告包括支持函数符号只有当金宝appInclude金宝appSupportingFunctions真正。该MATLABFunction记者创造本报记者的副本要报告的每个符号,并使用复制到报告上的符号性质。报告功能和符号属性是:

功能属性 描述
功能名称 函数的名称
功能ID 功能的标识。金宝appSimulink的一个唯一的ID分配到每个MATLAB功能在一个模型,每一个支撑作用。金宝app一个内置的或用户定义的支撑功能使用其相同的ID,不管它金宝app在给定的模型多少功能支持。
路径 的功能,这也是该模型能路径的路径MATLAB功能阻止或包含它Stateflow的块。支撑功能的路径是定义它的MA金宝appTLAB文件的路径。

变量属性 描述
名称 变量的名称,
数据类型 数据类型和变量的大小
起始位置 变量名在其中出现该脚本的第一个字符的行和列数

操作属性 描述
类型 字符或表示操作类型的字符。例如,+
数据类型 数据类型和值的大小产生由操作
起始位置 在它出现的脚本运行的第一个字符的行和列数

函数调用的位置属性 描述
名称 被调用函数的名称
数据类型 数据类型和值的大小,返回被调用函数
ID 被调用函数的ID
起始位置 通话现场,在它出现的脚本的第一个字符的行和列数

要自定义函数符号数据表的外观,定制默认BaseTable记者或者用的定制版本来替换它BaseTable记者。如果您指定标题在默认或更换财产内容BaseTable记者,这些内容被放置在默认的标题在生成的报告的前面。

是否包括支持功能,指定作为逻辑。金宝app如果,该报告不包括由功能脚本直接或间接调用的函数列表。如果真正,所述报告包括所述支撑功能。金宝app

金宝app支撑功能类型被报告,指定为单元阵列。单元阵列可以包括这些特征向量的一个或两个。

  • 'MATLAB'- 仅包括MATLAB支持功能金宝app

  • “用户定义的” - 仅包括用户定义的支持功能金宝app

金宝app支持功能的记者,指定为BaseTable,其列出了由功能MATLAB函数脚本直接或间接调用。该功能由功能名称排序。

要定制配套功能表的外观,定制默认金宝appBaseTable记者或者用的定制版本来替换它BaseTable记者。

模板为此记者,在这些方式中的一种指定的来源:

  • 指定文件包含模板为此记者路径矢量字符或字符串标量

  • 记者或报告其模板用于记者或它的模板库中包含了本报记者的模板

  • DOM文档或文档的一部分,其模板用于记者或它的模板库中包含了本报记者的模板

指定的模板必须是同一类型的哪个记者附加的报告。例如,对于一个微软®报告,TemplateSrc必须是一个Word模板记者。如果TemplateSrc属性为空,记者使用默认的记者模板报表的输出类型。

模板为此记者,指定为文字载体或串标名称。为此记者模板是在模板源的模板库(TemplateSrc)对本报记者表示。

超链接目标为此记者,指定为字符向量或标量的字符串指定链接目标ID,或mlreportgen.dom.LinkTarget宾语。字符向量或串标量值变换为LinkTarget宾语。链接目标对象立即之前本报记者在输出报告的内容。

方法

createTemplate 创建MATLAB功能模板记者
customizeReporter 创建自定义MATLAB功能类记者
getClassFolder MATLAB记者函数类定义文件的位置

继承的方法

getImpl 获取执行记者

复制语义

处理。要了解手柄类如何影响复制操作,请参阅复制对象(MATLAB)。

例子

加入MATLAB功能属性,参数和功能脚本

创建使用一个PDF报告生成器MATLABFunction记者。记者包括有关信息MATLAB功能块在sldemo_radar_eml模型。该报告,在默认情况下,包括对象属性的表中,输入和输出参数的表,并且函数的脚本。

。进口slreportgen.report *进口mlreportgen.report *模型名称= 'sldemo_radar_eml'。load_system(模型名称);mlfcnobj = 'sldemo_radar_eml / MATLAB函数';RPT = slreportgen.report.Report( '输出', 'PDF');章=章(mlfcnobj);RPTR = MATLABFunction(mlfcnobj);添加(章,RPTR);添加(RPT,章);关闭(RPT);close_system(模型名称); rptview(rpt);

生成的报告的第一页显示。

加入MATLAB函数参数详细信息

创建使用的HTML报告生成MATLABFunction记者和包括MATLAB功能参数细节。使用IncludeArgumentProperties属性包括用于每个的表MATLAB功能块的输入和输出参数。本例使用sldemo_radar_eml模型。

。进口slreportgen.report *进口mlreportgen.report *模型名称= 'sldemo_radar_eml'。load_system(模型名称);mlfcnobj = 'sldemo_radar_eml / MATLAB函数';RPT = slreportgen.report.Report( '输出', 'HTML');章=章(mlfcnobj);RPTR = MATLABFunction(mlfcnobj);rptr.IncludeArgumentProperties = TRUE;添加(章,RPTR);添加(RPT,章);关闭(RPT); close_system(model_name); rptview(rpt);

所生成的报告的这部分显示了一些参数的细节的表。

更改功能的MATLAB脚本格式和标题

创建使用的HTML报告生成MATLABFunction记者和集功能脚本和标题的外观。更改的外观MATLAB功能阻断报告的功能脚本部分。使用FunctionScriptTitle属性来指定文本在默认功能脚本表标题的前面加。创建并使用DOM段落改变字体,字体大小和脚本的颜色。本例使用sldemo_radar_eml模型。

。进口slreportgen.report *进口mlreportgen.report *模型名称= 'sldemo_radar_eml'。load_system(模型名称);mlfcnobj = 'sldemo_radar_eml / MATLAB函数';RPT = slreportgen.report.Report( '输出', 'HTML');章=章(mlfcnobj);RPTR = MATLABFunction(mlfcnobj);paraTitle = mlreportgen.dom.Paragraph( 'SCRIPT:');rptr.FunctionScriptTitle = paraTitle;paraScript = mlreportgen.dom.Paragraph;paraScript.FontFamilyName = 'Arial字体'; paraScript.FontSize = '12pt'; paraScript.Color = 'blue'; rptr.FunctionScript = paraScript; add(chapter,rptr); add(rpt,chapter); close(rpt); close_system(model_name); rptview(rpt);

所生成的报告显示这部分“SCRIPT:”添加到标题和12磅Arial字体蓝色字体。

介绍了在R2018a