主要内容

slreportgen.report.ModelVariable类

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

模型变量报告器

描述

一个Simulink的记者万博1manbetx®模型变量。

请注意

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

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

类属性

HandleCompatible
真正的

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

创建

描述

您不需要创建slreportgen.report.ModelVariable对象明确。为了得到slreportgen.report.ModelVariable对象获取已找到的模型变量:

  • 使用找到下一个方法slreportgen.finder.ModelVariableFinder对象来获取slreportgen.finder.ModelVariableResult对象获取所找到的变量。

  • 调用getReporter方法slreportgen.finder.ModelVariableResult对象来获取slreportgen.report.ModelVariable对象。

属性的属性,可以自定义模型变量的报告slreportgen.report.ModelVariable对象。

属性

全部展开

万博1manbetx仿真软件。变量Usage对象,该对象与要报告的变量对应。对象包含变量的名称、变量的源和使用变量的块。此属性是只读的。

路径模型块,用于设置指定为字符向量的变量值。

假设引用的模型使用模型参数来设置块参数值。如果一个模型有被引用模型的多个实例,模型变量查找器将返回与模型参数相关联的变量的多个实例。的ModelBlockPath属性通过提供到设置变量值的模型块的路径来惟一地标识变量的实例。如果变量与引用模型中的模型参数没有关联,则ModelBockPath是空的。有关引用模型和特定于实例的参数的详细信息,请参见参数化可重用引用模型的实例

是否包含使用此变量的块列表,指定为真正的.如果FormatPolicy属性的值为“内联文本”的值,则该块列表不包括在报告中ShowUsedBy财产。

如果报告在Used By列表中包含某个块的报告内容,则单击该块的超链接会将您带到该内容。看到生成模型变量、图表和块的报告

是否包括在其中解析变量的工作空间,指定为真正的.如果FormatPolicy属性的值为“内联文本”的值,工作区都不包括在报表中ShowWorkspaceInfo财产。

属性指定的变量的列表格式化器,用于格式化使用该变量的块列表mlreportgen.dom.UnorderedList对象或mlreportgen.dom.OrderedList对象。此属性的默认值是对象mlreportgen.dom.UnorderedList.若要自定义列表的格式,请修改列表对象属性或将列表对象替换为不包含列表项的自定义列表对象。

变量值的格式,指定为以下字符串或字符向量之一:

  • “汽车”—根据变量值的数据类型,将变量值格式化为表格或段落。

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

    • 单元阵列

    • 逻辑阵列

    • 数字数组

    • MATLAB®表格

    • 万博1manbetx模型对象

    • Stateflow®对象

    • 图形对象

    • MATLAB结构或结构数组

    • MATLAB对象或对象数组

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

    • 细胞向量

    • 逻辑标量或向量

    • 数值标量或向量

    • 字符或字符数组

    • 字符串

    • MATLAB结构向量

    • MATLAB对象向量

  • “表”—将变量值格式化为表格形式。默认情况下显示为段落的变量被格式化为表项。作为层次结构对象的变量,例如MATLAB结构、MATLAB对象、Simulink对象、Stateflow对象或图形对象,可以具有本身就是对象的属性。万博1manbetx在这种情况下,层次结构被平铺,属性值显示为指向该对象属性表的超链接。对象属性表还有一个指向原始表的超链接。

  • “段落”—将变量值格式化为一段。默认情况下格式化为表格的变量将被平铺并格式化为段落。

  • “内联文本”—按照文本格式格式化变量。

表报告器用于格式化变量的值,变量指定为mlreportgen.report.BaseTable对象。此属性的默认值是aBaseTable对象的TableStyleName属性设置为ModelVariableTable样式的默认模板中定义的ModelVariable记者。

若要自定义表的外观,请修改默认表报告器的属性,或将其替换为自定义表报告器。中添加内容标题属性时,生成的报表中的内容将显示在表标题前面。

段格式化器来格式化模型变量的值,该变量指定为mlreportgen.dom.Paragraph对象。此属性的默认值是aBaseTable对象的TableStyleName属性设置为ModelVariableParagraph样式的默认模板中定义的ModelVariable记者。

属性的属性,可自定义段落的外观mlreportgen.dom.Paragraph对象或将对象替换为自定义的mlreportgen.dom.Paragraph对象。如果向默认或替换段落对象添加内容,则该内容将显示在生成报告中的变量内容前面。

文本格式化器,用于在文本与周围文本一致时格式化模型变量的名称和值,指定为mlreportgen.dom.Text对象。若要自定义文本的外观,请修改默认文本的属性mlreportgen.dom.Text对象或将对象替换为自定义的mlreportgen.dom.Text对象。如果向默认或替换文本对象添加内容,则该内容将显示在生成报告中的变量内容前面。

要显示的表列的最大数目,指定为正整数。属性的值,如果列数大于MaxCols属性时,表将垂直切片。切片将表划分为多个表。

为结构化对象或结构化对象数组的变量报告的最大层数,指定为非负整数。的值小于或等于的级别DepthLimit被平铺成一系列相互连接的表(参见FormatPolicy属性)。不报告大于深度限制的级别。如果你设置DepthLimit属性为0时,不展开结构化对象。

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

是否包含标题,指定为真正的.标题包含变量名和数据类型(可选)。如果IncludeTitle真正的,标题包括在内。默认情况下,标题只包括变量的名称。要包含变量的数据类型,请设置ShowDataType财产真正的

要报告的变量的标题,指定为字符向量、字符串标量、mlreportgen.dom.Text对象,mlreportgen.dom.InternalLink对象,或mlreportgen.dom.ExternalLink对象。

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

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

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

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

如果没有指定标题属性时,标题是变量名。

是否显示标题中变量的数据类型,指定为真正的

是否显示具有空值的属性,指定为真正的.的ShowEmptyValues属性仅适用于MATLAB对象、Simulink对象和statflow对象变量。万博1manbetx

是否显示使用默认值指定为的属性真正的.的ShowDefaultValues属性仅适用于MATLAB对象、Simulink对象和statflow对象变量。万博1manbetx

函数或表达式从报表中过滤已报告模型变量的属性。将函数指定为函数句柄。将表达式指定为字符串标量或字符向量。此属性仅应用于包含对象的变量。如果你不提供PropertyFilterFcn,模型变量的所有属性都包含在报告中。

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

  • 以以下论点为例:

    • variableName—要上报的变量名称

    • variableObject—正在报告的变量

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

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

属性的显示描述而且复杂性属性万博1manbetx仿真软件。参数对象。

进口slreportgen.finder。*进口slreportgen.report。*rpt = slreportgen.report.Report(“modelvarrpt”“pdf”);Model_name = load_system(“sldemo_mdlref_datamngt”);查找器= slreportgen.finder.ModelVariableFinder(model_name);hasNext(finder) result = next(finder);varRptr = getReporter(结果);varRptr。PropertyFilterFcn = @varPropertyFilter;add (rpt, varRptr);结束关闭(rpt);close_system (model_name);rptview (rpt);函数tf = varPropertyFilter(~, variableObject,propertyName)如果isa (variableObject的万博1manbetx仿真软件。参数的) tf = (propertyName ==“描述”) | |...(propertyName = =“复杂性”);其他的Tf = false;结束结束

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

  • 可以使用变量variableNamevariableObject,propertyName

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

例如,此代码过滤CoderInfo的属性万博1manbetx仿真软件。参数对象。

进口slreportgen.finder。*进口slreportgen.report。*rpt = slreportgen.report.Report(“modelvarrpt”“pdf”);Model_name = load_system(“sldemo_mdlref_datamngt”);查找器= slreportgen.finder.ModelVariableFinder(model_name);hasNext(finder) result = next(finder);varRptr = getReporter(结果);varRptr。PropertyFilterFcn ="isFiltered = "+..."isa(variableObject, '万博1manbetxSimulink.Parameter') && "+..."propertyName == 'CoderInfo';";add (rpt, varRptr);结束关闭(rpt);close_system (model_name);rptview (rpt);

用于显示非整型数值的格式或精度。

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

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

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

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

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

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

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

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

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

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

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

方法

全部展开

例子

全部折叠

属性的属性slreportgen.report.ModelVariable对象自定义变量的格式。

%创建报表rpt = slreportgen.report.Report(“MyReport”“pdf”);%创建章节chapter = mlreportgen.report.Chapter();一章。Title =“模型变量报告实例”加载模型model_name =“slrgex_sf_car”;load_system (model_name);找到模型中的变量查找器= slreportgen.finder.ModelVariableFinder(model_name);hasNext(finder) result = next(finder);获取结果的ModelVariable报告器%自定义数字格式reporter = getReporter(结果);记者。NumericFormat =“% .4f”将记者添加到章节添加(章,记者);结束在报告中添加章节add (rpt,章);关闭报告并打开查看器关闭(rpt);rptview (rpt);

生成包括以下内容的报告:

  • 模型变量的一章

  • 每个模型图都有一章,图中的块有一节

模型变量的Used By列表中的每个块名都是指向该块报告的相应内容的超链接。

%创建报表rpt = slreportgen.report.Report(“MyReport”“pdf”);加载模型model_name =“slrgex_sf_car”;load_system (model_name);为变量创建一个章节chapter = mlreportgen.report.Chapter();一章。Title =sprintf(%s模型的模型变量报告, model_name);找到模型中的变量查找器= slreportgen.finder.ModelVariableFinder(model_name);报告变量hasNext(finder) result = next(finder);reporter = getReporter(结果);添加(章,记者);结束add (rpt,章);向报告中添加图表finder = slreportgen.finder.DiagramFinder(model_name);hasNext(finder) result = next(finder);ch = mlreportgen.report.Chapter(result.Name);添加(ch,结果);为图表中的块添加一个部分section = mlreportgen.report.“标题”“块”);blFinder = slreportgen.finder.BlockFinder(result.Object);hasNext(blFinder) blockresult = next(blFinder);add(教派,blockresult);结束添加(ch,教派);add (rpt, ch);结束%关闭并查看报表关闭(rpt);rptview (rpt);

版本历史

R2019b引入