本页采用了机器翻译。点击此处可查看最新英文版本。

slreportgen.report.SimulinkObjectProperties 类

命名空间: slreportgen.report
超类: slreportgen.report.Reporter

Simulink 对象属性报告器

全页展开

描述

SimulinkObjectProperties 报告器生成表格，列出 Simulink® 对象的属性和属性值。

注意

要在报告中使用 Simulink 对象属性报告器，您必须使用 slreportgen.report.Report 类创建报告。

slreportgen.report.SimulinkObjectProperties 类是 handle 类。

创建对象

描述

reporter = SimulinkObjectProperties 创建一个空的 Simulink 对象属性报告器。使用 Object 属性指定要报告的对象。

要指定包含在生成的属性表中的 Simulink 对象属性列表，请使用报告器的 Properties 属性。如果您未指定任何属性，报告器将根据对象类型包含一组默认属性。例如，模块的属性表包括由其参数对话框设置的属性。

要自定义生成的属性表的格式，请使用 PropertyTable 属性。

注意

如果模型尚未编译，则此报告器将编译包含要报告的对象的模型。当模型尚未编译时，编译模型对于将值传播到未指定的属性是必要的。当您关闭包含生成的属性表的报告时，模型尚未编译。

reporter = SimulinkObjectProperties(obj) 创建一个报告器，生成一个表，列出指定 Simulink 对象的属性值。

示例

reporter = SimulinkObjectProperties(Name=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

示例

输入参量

全部展开

请参阅 Object 属性。

属性

全部展开

要报告其属性的 Simulink 对象，指定为指定对象的路径或句柄。Object 值必须是以下对象类型之一：

  • 模型

  • 模块

  • 注解

  • 端口

  • 线条

  • 线段

对象属性表报告器，指定为 mlreportgen.report.BaseTable 报告器。对象属性报告器使用基表报告器来格式化对象属性。如果该属性最初为空，则对象属性报告器会将该属性设置为默认属性表报告器。要自定义属性表格式，请将此属性设置为符合您的格式需求的基表报告器。

选择将属性名称显示为对话框提示，指定为逻辑值。如果 true 和属性出现在对象的对话框中，则表会列出其对话框提示而不是其属性名称。否则，生成的属性表将使用其属性名称列出该属性。

选择显示具有空值的属性。

是否显示具有空值的属性，指定为逻辑值。如果是 false，则生成的对象属性表省略了值为空的对象属性。如果是 true，则表包含值为空的属性。

要报告的对象属性的名称，指定为元胞数组。

要报告的对象属性名称元胞数组，指定为由字符串或字符向量组成的元胞数组。如果您未指定任何属性，则报告器将确定一组要报告的属性。

此报告器的模板来源，以下列方式之一指定：

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

  • 此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告

  • 文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

此报告器的模板名称，指定为字符向量或字符串标量。此报告器的模板必须位于此报告器 TemplateSrc 属性所指定模板的模板库中。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

使用 SimulinkObjectProperties 报告器将 vdp 模型的属性表添加到报告。

import slreportgen.report.*
import mlreportgen.report.*
model_name = "vdp";
load_system(model_name);

rpt = slreportgen.report.Report("output","pdf");
chapter = Chapter(model_name);
rptr = SimulinkObjectProperties(model_name);

add(chapter, rptr);
add(rpt, chapter);
close(rpt);
close_system(model_name);
rptview(rpt);
打开实时脚本

向报告中添加属性表并仅包含模型线段的属性。

import slreportgen.report.*
import mlreportgen.report.*
model_name = "vdp";
rpt = slreportgen.report.Report("output","pdf");
chapter = Chapter(model_name);

load_system(model_name);
ph = get_param("vdp/Mu","PortHandles");
outPort = ph.Outport;
line = get_param(outPort,"Line");
rptr = SimulinkObjectProperties(line);
rptr.Properties = {"Parent","SourcePort","StorageClass"};

add(chapter,rptr);
add(rpt,chapter);

close(rpt);
rptview(rpt);
close_system(model_name);

版本历史记录

在 R2017b 中推出

另请参阅

|

主题