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

slreportgen.report.SystemIO 类

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

Simulink 系统输入输出信号报告器

全页展开

描述

创建一个报告器，报告进入或离开 Simulink® 模型或子系统的信号。

注意

要在报告中使用 SystemIO 报告器，您必须使用 slreportgen.report.Report 类创建报告。

slreportgen.report.SystemIO 类是 handle 类。

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

描述

slreportgen.report.SystemIO 创建一个空的 slreportgen.report.SystemIO 报告器对象。使用 Object 属性指定要报告的模型或子系统。默认情况下，报告器会生成系统输入和输出的摘要表。输入摘要表列出了输入信号的来源。输出摘要表列出了输出信号的目标。报告器还生成一个信号详细信息节，列出输入和输出端口的属性。使用报告器属性来自定义所生成报告的内容和外观。例如，使用 DetailsReporter 属性自定义信号详细信息节的内容和外观。

slreportgen.report.SystemIO(object) 为 object 指定的模型或子系统创建一个报告器。请参阅 Object 属性。

示例

slreportgen.report.SystemIO(Name=Value) 使用名称-值参量设置报告器属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

Simulink 要报告的模型或子系统，指定为字符向量或字符串标量，其中包含模型的路径或子系统的路径，作为模型的句柄或子系统的句柄，作为 slreportgen.finder.DiagramResult 对象，或作为 slreportgen.finder.BlockResult 对象。

属性：

GetAccess
公共
SetAccess
公共

要报告的每个输入的属性列表，指定为字符串数组或字符向量元胞数组。默认情况下，列表包括 Port、Inport Block、Source、Name 和 DataType。报告的 Inport Block 的值是与系统中的输入信号相对应的 Inport 模块的名称。您可以在列表中包含以下信号属性：

  • "Port"

  • "Source"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

您还可以指定相应 Inport 模块的这些模块属性：

  • "Inport Block"

  • "Inport Block Description"

属性：

GetAccess
公共
SetAccess
公共

要报告的每个输出的属性列表，指定为字符串数组或字符向量元胞数组。默认情况下，列表包括 Port、Outport Block、Destination、Name 和 DataType。报告的 Outport Block 的值是与系统中的输出信号相对应的 Outport 模块的名称。您可以在列表中包含以下信号属性：

  • "Port"

  • "Destination"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

您还可以指定相应 Outport block 的这些模块属性：

  • "Outport Block"

  • "Outport Block Description"

属性：

GetAccess
公共
SetAccess
公共

是否显示汇总子系统或模型输入的表格，指定为 true 或 false。InputSummaryProperties 属性决定表包含哪些输入属性。

属性：

GetAccess
公共
SetAccess
公共

是否显示汇总子系统或模型输出的表格，指定为 true 或 false。OutputSummaryProperties 属性决定表包含哪些输出属性。

属性：

GetAccess
公共
SetAccess
公共

是否显示每个输入或输出的详细信息，指定为 true 或 false。如果 ShowDetails 是 true，则报告器在输入和输出摘要表后插入 slreportgen.report.SimulinkObjectProperties 报告器。如果 Object 是一个模型，则会包含有关输入或输出模块的详细信息。如果 Object 是一个子系统，则会包含有关输入或输出端口的详细信息。摘要表中的端口号链接到该端口对应的 SimulinkObjectProperties 报告器。

属性：

GetAccess
公共
SetAccess
公共

是否在摘要表中显示空列，指定为 true 或 false。如果 ShowEmptyColumns 是 true，则摘要表包含没有数据的列。

属性：

GetAccess
公共
SetAccess
公共

输入摘要表的表格格式化程序，指定为 mlreportgen.report.BaseTable 报告器。默认值是 BaseTable 报告器。要自定义表格的外观，请修改默认表格报告器的属性或将其替换为自定义的表格报告器。如果您向默认或自定义表格报告器的 Title 属性添加内容，则该内容将显示在生成的报告中的表格标题前面。

属性：

GetAccess
公共
SetAccess
公共

输出摘要表的表格格式化程序，指定为 mlreportgen.report.BaseTable 报告器。默认值是 BaseTable 报告器。要自定义表格的外观，请修改默认表格报告器的属性或将其替换为自定义的表格报告器。如果您向默认或自定义表格报告器的 Title 属性添加内容，则该内容将显示在生成的报告中的表格标题前面。

属性：

GetAccess
公共
SetAccess
公共

详细表的格式化程序，指定为 slreportgen.report.SimulinkObjectProperties 报告器。默认值是 SimulinkObjectProperties 报告器。要自定义详细表的外观，请修改默认 SimulinkObjectProperties 报告器的属性或将其替换为自定义的 SimulinkObjectProperties 报告器。

属性：

GetAccess
公共
SetAccess
公共

源列表和目标列表的列表格式化程序，指定为 mlreportgen.dom.UnorderedList 或 mlreportgen.dom.OrderedList 对象。源列表是输入信号连接到的模块的列表。目标列表是输出信号连接到的模块的列表。默认格式化程序是 UnorderedList 对象。要自定义列表的外观，请修改默认列表格式化程序的属性或将其替换为不包含任何子项的自定义列表对象。

属性：

GetAccess
公共
SetAccess
公共

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

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

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

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

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

属性：

GetAccess
公共
SetAccess
公共
NonCopyable
true

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

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

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

属性：

GetAccess
公共
SetAccess
公共

方法

全部展开

示例

全部折叠

打开实时脚本

此示例使用 slreportgen.report.SystemIO 报告器来报告模型及其子系统的输入和输出。

model_name = "f14";
load_system(model_name);

创建 Simulink 报告。

rpt = slreportgen.report.Report("SystemIO_example","docx");

创建查找器来查找模型中的所有图。

finder = slreportgen.finder.DiagramFinder(model_name);

报告每个图的输入和输出。创建 SystemIO 报告器并添加到报告。

ch = mlreportgen.report.Chapter("Diagrams");
while hasNext(finder)
  result = next(finder);
  if strcmpi(result.Type,"Simulink.SubSystem") ...
          || strcmpi(result.Type,"Simulink.BlockDiagram")
      sect = mlreportgen.report.Section(result.Name);
      add(sect,result);
      ioRptr = slreportgen.report.SystemIO(result);        
      add(sect,ioRptr);
      add(ch,sect);
  end
end

将章节添加到报告并关闭报告。

add(rpt,ch);
close(rpt);
rptview(rpt);

提示

  • SystemIO 报告器报告的输入和输出信号属性与 Simulink 属性相对应，您可以使用 get_param 进行查询。例如，DataType 和 Dimensions 属性对应于端口句柄的 Simulink CompiledPortDataType 和 CompiledPortDimensions 属性。

  • 对于总线信号，Simulink 根据信号是非虚拟总线还是虚拟总线来确定 CompiledPortDataType 和 CompiledPortDimensions 属性的值。

版本历史记录

在 R2020a 中推出

全部展开

另请参阅

|

主题