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

slreportgen.finder.AnnotationFinder 类

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

查找 Simulink 注解对象

全页展开

描述

在 Simulink® 或 Stateflow® 图中查找注解对象。

slreportgen.finder.AnnotationFinder 类是 handle 类。

创建对象

描述

finder = AnnotationFinder(diagram) 创建一个查找器，默认查找指定图中的所有注解。要将搜索限制到特定类型的注解，请使用此查找器的属性。

注意

此查找器提供了以下选项来获取搜索结果：

  • 要将搜索结果作为数组返回，请使用 find 方法。将结果直接添加到报告中或在 for 循环中处理结果。

  • 要逐个迭代结果，请在 while 循环中使用 hasNext 和 next 方法。

这两个选项在性能上都没有优势。

示例

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

输入参量

全部展开

请参阅 Container 属性。

属性

全部展开

要搜索的图，指定为以下值之一：

  • Simulink 模块的句柄

  • Simulink 模块的路径

  • Stateflow 图模块句柄

  • Stateflow 图模块的路径

  • Stateflow 图 ID

  • Stateflow 图对象

属性：

GetAccess
公共
SetAccess
公共

对查找器结果进行排序，指定为以下值之一：

值描述
"none"不对结果进行排序。
"alphabetical"按名称的字母顺序对结果进行排序。
"systemAlpha"按父系统名称的字母顺序对结果进行排序。
"depth"按在模型层次结构中的深度对结果进行排序。排序列表中的第一个对象是层次结构中最高的对象。例如，一个模型及其子系统按以下顺序排序： myModel、myModel/subsystem1、myModel/subsystem1/nestedSubststem。

属性：

GetAccess
公共
SetAccess
公共

数据类型: char | string

搜索 Container 的级别数，指定为以下值之一：

值描述
[]（默认）

  • 如果 Container 是模块图，则仅搜索图的顶层。

  • 如果 Container 是 Stateflow 图，则仅搜索从图顶层可见的元素。搜索包括嵌套状态中的元素，但排除子图中的元素。

非负整数

搜索指定层数

Inf

搜索所有层级

要查找的对象的属性，指定为名称-值参量的元胞数组。查找器仅返回具有指定属性和指定值的对象。

示例: finder.Properties = {'Gain','5'}

属性：

GetAccess
公共
SetAccess
公共

数据类型: cell

方法

全部展开

示例

全部折叠

此示例使用:

打开实时脚本

创建一份报告，查找 sf_car 模型中的注解。

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

model_name = "sf_car";
load_system(model_name);

rpt = slreportgen.report.Report("output","pdf");
add(rpt,TitlePage(...
            Title="Annotations in "+model_name+" Model"));
add(rpt,TableOfContents);

diagFinder = SystemDiagramFinder(model_name);
diagrams = find(diagFinder);
while hasNext(diagFinder)
    diagram = next(diagFinder);
    annotFinder = AnnotationFinder(diagram.Object);
    annotations = find(annotFinder);
    if ~isempty(annotations)
        chapter = Chapter(Title=diagram.Name);
        add(chapter, diagram);
        sect = Section(Title="Annotations");       
        add(sect,annotations);
        add(chapter,sect);
        add(rpt,chapter);
    end
end

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

版本历史记录

在 R2017b 中推出

另请参阅

| | | | |

主题