主要内容

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

slreportgen.finder.SignalResult 类

命名空间: slreportgen.finder
超类: mlreportgen.finder.Result

信号搜索结果对象

自 R2021a 起

描述

slreportgen.finder.SignalResult 类的对象表示对模型或模块使用的信号的搜索结果。您可以将 SignalResult 对象直接附加到报告中。或者,您可以使用 getReporter 方法访问结果的 slreportgen.report.Signal 报告器,然后自定义报告器并将其附加到报告中。

slreportgen.finder.SignalResult 类是 handle 类。

类属性

HandleCompatible
true

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

创建对象

您没有明确创建 slreportgen.finder.SignalResult 对象。slreportgen.finder.SignalFinder findnext 方法为找到的每个信号创建一个 slreportgen.finder.SignalResult 对象。

属性

全部展开

公共属性

要添加到结果中的用户定义的额外信息,指定为任意值。

属性:

GetAccess
公共
SetAccess
公共
NonCopyable
true

受保护的属性

表示找到的信号的模块输出端口,指定为句柄。此属性为只读属性。

找到的信号的名称,指定为字符串标量。此属性为只读属性。

作为所发现信号源的模块的名称,指定为字符串标量。此属性为只读属性。

代表找到的信号的输出端口的编号,指定为整数。此属性为只读属性。

使用此信号的模型或模块的名称,指定为字符串标量。该属性的值与用于查找此信号的 slreportgen.finder.SignalFinder 对象的 Container 属性的值相对应。此属性为只读属性。

找到的信号与容器模型或模块的关系,指定为 "Input""Output""Internal""Control""State"。容器模型或模块由 RelatedObject 属性指定。

方法

全部展开

示例

全部折叠

使用 getReporter 对象的 slreportgen.finder.SignalResult 方法来访问结果的信号报告器。然后,通过设置其属性来自定义报告器。

导入 MATLAB 和 Simulink 报告 API 包,这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*
import slreportgen.report.*

创建 Simulink 报告。

rpt = slreportgen.report.Report("MySignalReport","pdf");

为信号信息创建一个章节。

chapter = mlreportgen.report.Chapter();
chapter.Title = "Signals";

加载 vdp 模型。

model_name = "vdp";
load_system(model_name);

创建信号查找器。

finder = slreportgen.finder.SignalFinder(model_name);

查找信号。对于每个发现的信号,获取报告器,指定您想要报告空属性值,并将报告器添加到章节中。

while hasNext(finder)
    result = next(finder);
    
    reporter = getReporter(result);
    reporter.ShowEmptyValues = true;
 
    add(chapter,reporter);
end

将章节添加到报告中。

add(rpt,chapter);

关闭并查看报告。

close(rpt);
rptview(rpt);

版本历史记录

在 R2021a 中推出