主要内容

slreportgen.report.ModelConfiguration类

包:slreportgen.report
超类:slreportgen.report.Reporter

模型配置集报告器

描述

对象的对象slreportgen.report.ModelConfiguration类来报告模型的活动配置集。

请注意

使用slreportgen.report.ModelConfiguration报表中的报表,则必须使用slreportgen.report.Report类或子类。

slreportgen.report.ModelConfiguration类是一个处理类。

类属性

HandleCompatible
真正的

有关类属性的信息,请参见类属性

创建

描述

记者= slreportgen.report.ModelConfiguration ()创建一个空ModelConfiguration基于默认模板的报表对象。属性指定要为其报告活动配置集的模型模型财产。使用其他属性指定报表选项。

例子

记者= slreportgen.report.ModelConfiguration (模型创建一个ModelConfiguration对象,并设置模型属性设置为指定的模型。

记者= slreportgen.report.ModelConfiguration (名称=值使用名称-值对设置报告器属性。您可以以任意顺序指定多个名称-值对参数。

属性

全部展开

打开或加载的Simulink的名称或句柄万博1manbetx®模型,指定为字符串标量、字符向量或句柄。

配置集标题,指定为字符向量,字符串标量,mlreportgen.dom.Text对象,mlreportgen.dom.InternalLink对象,或mlreportgen.dom.ExternalLink对象。

如果FormatPolicy属性设置为“内联文本”标题属性设置为:

  • DOM对象时,DOM对象指定的格式将被忽略

  • 一个mlreportgen.dom.InternalLinkmlreportgen.dom.ExternalLink对象时,链接文本用于标题,但标题不是链接

在这两种情况下,要格式化标题,请使用定义这个的性质ModelConfiguration记者。

如果未指定标题,则标题为模型名称后跟配置设置.例如:

slrgex_sf_car配置集

报告配置集的格式,指定为以下字符串或字符向量之一:

  • “汽车”—根据数据类型,将配置集、组件和属性值格式化为表格或段落。

    格式化为表的数据类型包括:

    • 单元阵列

    • 逻辑阵列

    • 数字数组

    • MATLAB®表格

    • 万博1manbetx模型对象

    • Stateflow®对象

    • 图形对象

    • MATLAB结构或结构数组

    • MATLAB对象或对象数组

    格式为段落的数据类型包括:

    • 细胞向量

    • 逻辑标量或向量

    • 数值标量或向量

    • 字符或字符数组

    • 字符串

    • MATLAB结构向量

    • MATLAB对象向量

    因为配置集和组件是对象,所以它们被格式化为表。属性值根据值的数据类型进行格式化。

  • “表”—格式化表格中的值。默认情况下显示为段落的数据类型被格式化为表项。属于层次结构对象的数据类型(如MATLAB结构、MATLAB对象、Simulink对象、Stateflow对象或图形对象)可以具有本身就是对象的属性。万博1manbetx在这些情况下,层次结构是扁平的,属性值是指向字段或对象属性表的超链接。字段或属性表链接回原始表。

  • “段落”—以段落的形式生成配置集的描述。例如:

    第一段是“来源类型:模型”。第二段是“源名称:slrgex_sf_car”。第三段是“slrgex_sf_car配置集。配置(活动)”。

  • “内联文本”—生成与周围文本一致的配置集描述。例如:

    单行行内文本,阅读“slrgex_sf_car配置集配置(Active)在slrgex_sf_car (Model)”

控件的表格式化程序ModelConfiguration生成的报告,指定为mlreportgen.report.BaseTable对象。此属性的默认值是aBaseTable对象的TableStyleName属性设置为ModelConfigurationTable样式的默认模板中定义的ModelConfiguration记者。若要自定义表的外观,请修改默认表的属性BaseTable对象或将该对象替换为您自己的对象BaseTable对象。中添加内容标题属性时,内容将显示在生成的报表中的表标题前面。

项指定的任何模型配置内容的段格式化程序,该内容作为段生成mlreportgen.dom.Paragraph对象。此属性的默认值是a对象的StyleName属性属性设置为ModelConfigurationParagraph样式的默认模板中定义的ModelConfiguration记者。若要自定义段落的外观,请修改默认值的属性对象或将该对象替换为您自己的对象对象。如果您将内容添加到段落对象中,该内容将出现在生成的报告中的模型配置内容前面。

的文本格式化器,用于生成为内联文本的任何模型配置内容,指定为mlreportgen.dom.Text对象。默认情况下,此属性的值为空文本对象。若要自定义文本的外观,请修改默认文本的属性mlreportgen.dom.Text对象或将对象替换为自定义的mlreportgen.dom.Text对象。中添加内容文本对象时,该内容出现在生成的报告中的模型配置内容前面。

值表中表列的最大数目,以正整数指定。属性值使用表报告,且列数大于属性的值MaxCols属性时,表将垂直切片。切片将表划分为多个表。

要报告的结构化对象层次结构中嵌套的最大级别数,指定为非负整数。层次结构的顶层是配置集对象(万博1manbetx仿真软件。ConfigSet).的值小于或等于的级别DepthLimit被平铺成一系列相互连接的表。不报告大于深度限制的级别。如果你设置DepthLimit财产0,不扩展层次结构类型。

要报告的对象层次结构中的最大对象数,指定为正整数。

是否包含配置集标题,指定为真正的

IncludeTitle真正的的内容标题属性)包含在:

  • 时,配置集属性表的FormatPolicy“汽车”“表”

  • 时生成的内容FormatPolicy“内联文本”“段落”

属性的值如何,配置集标题始终包含在包含配置集组件的段落或表的标题中IncludeTitle财产。

标题是否包含标题所描述的值的数据类型,指定为真正的

数据类型:逻辑

是否显示具有空值的配置集或组件属性,指定为真正的

数据类型:逻辑

是否显示使用默认值的配置集或组件属性,指定为真正的

数据类型:逻辑

函数或表达式从指定为函数句柄、字符串标量或字符向量的报表中筛选配置集和组件对象属性。将函数指定为函数句柄。将表达式指定为字符串标量或字符向量。如果PropertyFilterFcn为空时,所有属性都包含在报告中。

如果你提供了一个函数句柄,关联的函数必须:

  • 以以下论点为例:

    • variableName—要上报的变量名称

    • variableObject—正在报告的变量

    • propertyName—要报告的变量的属性名称

  • 返回真正的从报表中筛选指定的属性,或在报告中包括该物业。

例如,此代码使用PropertyFilterFcn属性,以防止显示的名字而且描述属性:

进口slreportgen.report。*rpt = slreportgen.report.Report(“MyReport”“pdf”);打开(rpt);模型=“slrgex_sf_car”;load_system(模型);reporter = ModelConfiguration(model);filterFcnHandle = @(变量名,变量对象,属性名)...(propertyName = =“名称”) | |...(propertyName = =“描述”);记者。PropertyFilterFcn = filterFcnHandle;追加(rpt,记者);关闭(rpt);rptview (rpt);

如果提供字符串标量或字符向量,则必须包含表达式。表达式:

  • 可以使用变量variableNamevariableObject,propertyName

  • 必须设置变量isFiltered真正的从报表中筛选指定的属性,或在报告中包括该物业

例如,此代码使用PropertyFilterFcn属性,以防止显示的名字而且描述属性:

进口slreportgen.report。*rpt = slreportgen.report.Report(“MyReport”“pdf”);打开(rpt);模型=“slrgex_sf_car”;load_system(模型);reporter = ModelConfiguration(model);filterStr ="isFiltered = "+...“比较字符串(propertyName '名称')| |比较字符串(“描述”propertyName);“;记者。PropertyFilterFcn = filterStr;追加(rpt,记者);关闭(rpt);rptview (rpt);

用于显示指定为字符串标量、字符向量或正整数的非整数数值的格式或精度。

将格式指定为字符串标量或字符向量。看到formatSpec关于sprintf参考页面。

将精度指定为正整数。看到精度关于num2str参考页面。

例子:“% .2f”显示小数点右侧有两位数字的双值。

例子:2显示两个有效数字的最大数目。

此报告的模板源,指定为以下选项之一:

  • 字符向量或字符串标量,指定包含此报表模板的文件的路径

  • 报表或报表,其模板用于此报表,或其模板库包含此报表的模板

  • DOM文档或文档部分,其模板用于此报表,或其模板库包含此报表的模板

指定的模板必须与该报表附加到的报表类型相同。例如,对于a微软®报告,TemplateSrc必须是Word报表模板。如果TemplateSrc属性为空时,此报表将为报表的输出类型使用默认报表模板。

此报表的模板名称,指定为字符向量或字符串标量。此报告的模板必须在模板源的模板库中(TemplateSrc)。

的超链接目标,指定为字符向量或指定链接目标ID的字符串标量,或指定为mlreportgen.dom.LinkTarget对象。字符向量或字符串标量值转换为LinkTarget对象。在输出报告中,链接目标紧跟在此报告器的内容之前。

方法

全部展开

例子

全部折叠

对象的对象slreportgen.report.ModelConfiguration类来报告活动模型配置集。

导入MATLAB Report和Simulink Repo万博1manbetxrt API包,这样您就不必使用长且完全限定的类名。

进口mlreportgen.report。*进口slreportgen.report。*

创建一个Simul万博1manbetxink报告。

rpt = slreportgen.report.Report(“MyReport”“pdf”);打开(rpt);

为活动模型配置集创建一个章节。

chapter = chapter ();一章。Title =“活动模型配置集”

加载一个模型。

模型=“slrgex_sf_car”;load_system(模型);

创建一个slreportgen.report.ModelConfiguration对象来报告模型的活动配置集。

reporter = ModelConfiguration(model);

将报告附加到章节,并将章节附加到报告。

追加(章,记者);追加(rpt,章);

关闭并查看报表

关闭(rpt);rptview (rpt);

版本历史

R2020b中介绍