slreportgen.finder.DiagramElementFinder 类

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

创建图元素查找器对象

描述

在 Simulink^® 模块或 Stateflow^® 图中查找元素。

slreportgen.finder.DiagramElementFinder 类是 handle 类。

创建对象

描述

finder = DiagramElementFinder(diagram) 创建一个查找器，用于查找 Simulink 模块或 Stateflow 图的元素。默认情况下，此查找器会在图中查找模块、注解、线条、状态和其他元素。使用查找器的属性将搜索限制到特定类型的元素。

注意

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

要将搜索结果作为数组返回，请使用 find 方法。将结果直接添加到报告中或在 for 循环中处理结果。
要逐个迭代结果，请在 while 循环中使用 hasNext 和 next 方法。

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

示例

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

输入参量

全部展开

`diagram` — 要搜索的图
路径 | 句柄 | 图 ID | 图对象

请参阅 Container 属性。

属性

全部展开

`Container` — 要搜索的图
路径 | 句柄 | 图 ID | 图对象

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

Simulink 模块的句柄
Simulink 模块的路径
Stateflow 图模块句柄
Stateflow 图模块的路径
Stateflow 图 ID
Stateflow 图对象

`Types` — 要查找的图元素类型
字符串标量 | 字符数组 | 字符串数组 | 由字符数组组成的元胞数组

要查找的 Simulink 或 Stateflow 图元素的类型，指定为字符串、字符数组、字符串数组或由字符数组组成的元胞数组。如果类型是数组，则指定一组元素类型。默认值为 All 或 all，查找所有图中的所有元素。使用这些值之一将搜索限制到特定的图元素类型。您可以使用完全限定名称或简称。

完全限定名称	简称
`All`	`all`
`Simulink.Annotation`	`annotation`
`Simulink.Block`	`block`
`Simulink.Segment`	`line`
`Simulink.Port`	`port`
`Stateflow.Annotation`	`sf_annotation`
`Stateflow.Box`	`box`
`Stateflow.EMFunction`	`emfunction`
`Stateflow.Function`	`function`
`Stateflow.Junction`	`junction`
`Stateflow.Port`	`sf_port`
`Stateflow.SLFunction`	`slfunction`
`Stateflow.State`	`state`
`Stateflow.Transition`	`transition`
`Stateflow.TruthTable`	`truthtable`

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string | cell

`IncludeCommented` — 包括注释掉的图元素
`false` (默认) | `true`

选择在搜索结果中包含注释掉的图元素，指定为逻辑值。如果是 false，注释掉的元素将被排除在搜索结果之外。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: logical

`IncludeVariants` — 包括图变体
`"Active"` (默认) | `"All"` | `"ActivePlusCode"` | ...

搜索图的变体，指定为字符串或字符向量。默认值为 Active。有效值为:

值	描述
`"Active"`	活动变体
`"All"`	所有变体
`"ActivePlusCode"`	活跃变体和代码变体

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`SearchDepth` — 搜索 `Container` 的层级数
`[]` (默认) | `Inf` | 非负整数

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

值	描述
`[]`（默认）	如果 `Container` 是模块图，则仅搜索图的顶层。如果 `Container` 是 Stateflow 图，则仅搜索从图顶层可见的元素。搜索包括嵌套状态中的元素，但排除子图中的元素。
非负整数	搜索指定层数
`Inf`	搜索所有层级

`SortType` — 对查找器结果进行排序
`"none"` (默认) | `"alphabetical"` | `"systemAlpha"` | `"depth"`

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

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

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`Properties` — 要查找的对象的属性
元胞数组

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

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

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: cell

方法

全部展开

公共方法

方法	描述
`find`	`results = find(finder)` 在查找器指定的 `diagram` 中查找图元素。此方法返回它在 `slreportgen.finder.DiagramElementResult` 类型的结果对象中找到的图元素。要添加图元素属性的表格，请将结果对象直接添加到报告中，或将它们添加到报告器中，然后将其添加到报告中。可以添加此方法的 `results` 的报告必须是 `slreportgen.report.Report` 类型的报告。
`hasNext`	`tf = hasNext(finder)` 确定查找器搜索的图是否至少包含一个元素。如果图至少有一个元素，则 `hasNext` 方法将该元素排队为 `next` 方法将返回的下一个元素。然后 `hasNext` 方法返回 `true`。使用 `next` 方法获取该元素。在后续调用中，`hasNext` 方法确定图是否具有 `next` 方法尚未检索的元素。它将元素排队以供 `next` 方法检索并返回`true`。如果不存在更多可检索元素，则此方法返回 `false`。要逐步搜索图中的元素，请在 `while` 循环中将 `hasNext` 方法与 `next` 方法结合使用。
`next`	`result = next(finder)` 返回 `hasNext` 方法创建的结果队列中的下一个搜索 `result`。该方法返回它在 `slreportgen.finder.DiagramElementResult` 类型的结果对象中找到的图元素。要添加图元素属性的表格，请将结果对象直接添加到报告中，或将它们添加到报告器中，然后将其添加到报告中。可以添加此方法的 `results` 的报告必须为 `slreportgen.report.Report` 类型。

示例

全部折叠

查找模块、注解和线元素

在 f14 模型中，查找模块、注解和线图元素，搜索深度为 1。

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

model_name = "f14";
openExample(model_name);

rpt = slreportgen.report.Report("output","pdf");
add(rpt, TitlePage(Title=sprintf("%s Model",model_name)));
add(rpt, TableOfContents);

diagFinder = SystemDiagramFinder(Container=model_name,SearchDepth=1);
while hasNext(diagFinder)
    system = next(diagFinder);
    chapter = Chapter(Title=system.Name);
    add(chapter,system);
    sect = Section(Title="Diagram Elements");
    elemFinder = DiagramElementFinder(...
                        Container=system.Object,...
                        Types=["block" "annotation" "line"]);
    elems = find(elemFinder);
    for elem = elems
        add(sect, elem);
    end  
    add(chapter, sect);
    add(rpt, chapter);
end

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

版本历史记录

在 R2017b 中推出

另请参阅

slreportgen.finder.DiagramElementFinder 类

描述

创建对象

描述

输入参量

diagram — 要搜索的图 路径 | 句柄 | 图 ID | 图对象

属性

Container — 要搜索的图 路径 | 句柄 | 图 ID | 图对象

Types — 要查找的图元素类型 字符串标量 | 字符数组 | 字符串数组 | 由字符数组组成的元胞数组

属性：

IncludeCommented — 包括注释掉的图元素 false (默认) | true

属性：

IncludeVariants — 包括图变体 "Active" (默认) | "All" | "ActivePlusCode" | ...

属性：

SearchDepth — 搜索 Container 的层级数 [] (默认) | Inf | 非负整数

SortType — 对查找器结果进行排序 "none" (默认) | "alphabetical" | "systemAlpha" | "depth"

属性：

Properties — 要查找的对象的属性 元胞数组

属性：

方法

公共方法

示例

查找模块、注解和线元素

版本历史记录

另请参阅

主题

`diagram` — 要搜索的图
路径 | 句柄 | 图 ID | 图对象

`Container` — 要搜索的图
路径 | 句柄 | 图 ID | 图对象

`Types` — 要查找的图元素类型
字符串标量 | 字符数组 | 字符串数组 | 由字符数组组成的元胞数组

`IncludeCommented` — 包括注释掉的图元素
`false` (默认) | `true`

`IncludeVariants` — 包括图变体
`"Active"` (默认) | `"All"` | `"ActivePlusCode"` | ...

`SearchDepth` — 搜索 `Container` 的层级数
`[]` (默认) | `Inf` | 非负整数

`SortType` — 对查找器结果进行排序
`"none"` (默认) | `"alphabetical"` | `"systemAlpha"` | `"depth"`

`Properties` — 要查找的对象的属性
元胞数组