slreportgen.finder.DiagramFinder 类

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

创建图查找器

描述

查找 Simulink^® 图和 Stateflow^® 图。

slreportgen.finder.DiagramFinder 类是 handle 类。

创建对象

描述

finder = DiagramFinder(container) 创建一个查找器，默认查找指定 container 中所有未注释的 Simulink 模块图和 Stateflow 图。要限制搜索以包含特定类型的图，请使用此查找器的属性。

注意

该查找器可以在查找模式或迭代器模式下运行。在查找模式下，使用其 find 方法将搜索结果作为结果数组返回。在迭代器模式下，使用其 hasNext 和 next 方法逐一返回搜索的结果。在具有许多模型引用的模型中搜索时，使用迭代器模式。迭代器模式在编译和搜索模型后会关闭该模型，而查找模式则会保持其搜索的所有模型处于打开状态。打开多个模型会消耗所有系统内存并减慢报告生成速度。迭代器模式比查找模式慢，因此使用查找模式来搜索引用很少或不引用其他模型的模型。

示例

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

示例

输入参量

全部展开

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

请参阅 Container 属性。

属性

全部展开

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

要搜索的模型容器，指定为以下值之一：

Simulink 模型、子系统或模型模块的句柄
Simulink 模型、子系统或模型模块的路径
Stateflow 图模块的句柄
Stateflow 图模块的路径
Stateflow 图 ID
Stateflow 图对象

`SearchDepth` — 系统图深度搜索
`Inf` (默认) | 正整数

系统图搜索的深度，指定为 Inf 或正整数。SearchDepth 指定在图容器中搜索图的深度级别。要搜索所有层级，请使用 Inf。

属性：

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

数据类型: double

`IncludeMaskedSubsystems` — 搜索封装子系统
`true` (默认) | `false`

选择搜索封装子系统，指定为逻辑值 1 (true) 或 0 (false)。如果此属性为 true，则查找器将在图容器中搜索封装的 Subsystem 模块。它搜索指定的 SearchDepth 并将找到的图包含在搜索结果中。

属性：

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

数据类型: logical

`IncludeReferencedModels` — 搜索模型引用
`true` (默认) | `false`

选择搜索引用模型，指定为逻辑值 1 (true) 或 0 (false)。如果此属性为 true，则查找器将搜索图容器中引用的模型。它搜索指定的 SearchDepth 并将找到的图包含在搜索结果中。

属性：

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

数据类型: logical

`IncludeReferencedSubsystems` — 是否搜索引用子系统
`true` 或 `1` (默认) | `false` 或 `0`

是否搜索引用子系统，指定为数值或逻辑 1 (true) 或 0 (false)。结果表明源子系统模块而不是所引用子系统模块的个别出现。因此，被多次引用的单个子系统只有一个结果。

数据类型: logical

`IncludeSimulinkLibraryLinks` — 搜索 Simulink 库链接
`true` (默认) | `false`

选择搜索 Simulink 库链接，指定为逻辑值 1 (true) 或 0 (false)。如果此属性和 IncludeMaskedSubsystems 都是 true，则查找器将在图容器中搜索指向 Simulink 库中的子系统和封装 Subsystem 模块的链接。它搜索指定的 SearchDepth 并将找到的图包含在搜索结果中。如果此属性为 true，但 IncludeMaskedSubsystems 为 false，则查找器仅搜索 Simulink 库中 Subsystem 模块的链接。

属性：

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

数据类型: logical

`IncludeUserLibraryLinks` — 搜索用户库链接
`true` (默认) | `false`

选择搜索用户库链接，指定为逻辑值 1 (true) 或 0 (false)。如果此属性为 true 且 IncludeMaskedSubsystems 属性为 true，则查找器将在图容器中搜索指向用户库中的子系统和封装子系统模块的链接。它搜索指定的 SearchDepth 并将找到的图包含在搜索结果中。如果此属性为 true，但 IncludeMaskedSubsystems 属性为 false，则查找器仅搜索用户库中 Subsystem 模块的链接。

属性：

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

数据类型: logical

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

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

属性：

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

数据类型: logical

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

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

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

属性：

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

数据类型: char | string

`SortType` — 查找器结果的排序方法
`"none"` (默认) | `"alphabetical"` | `"numBlocks"` | `"depth"`

查找器结果的排序方法，指定为下列值之一：

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

属性：

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

数据类型: char | string

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

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

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

属性：

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

数据类型: cell

`AutoCloseModel` — 是否关闭模型
`true` (默认) | `false`

是否关闭模型，指定为 true 或 false。如果是 true，则查找器的 next 方法会关闭当前打开的模型，然后再移动到下一个要搜索的模型。关闭模型可以防止在搜索引用许多模型的模型时过度消耗内存。

注意

查找器的 find 方法忽略此属性并将所有引用模型保持为打开状态。因此，您不应使用 find 方法来搜索具有许多模型引用的模型。

数据类型: logical

方法

全部展开

公共方法

find

results = find(finder) 在指定的 container 中查找图。finder 是一个 slreportgen.finder.DiagramFinder 对象。results 是一个 slreportgen.finder.DiagramResult 对象数组，每个对象都包含通过此方法找到的一个图。将此数组添加到报告或报告器将添加其包含的所有图的图像。可以添加此方法的 results 的报告是 slreportgen.report.Report 类型报告或其他报告器对象（例如 slreportgen.report.Chapter 报告器）。

注意

find 方法打开并编译顶层模型及其引用的所有模型。此方法在搜索结束时使所有模型保持打开状态，这可能会减慢包含许多模型引用的模型的报告速度。为了避免这种速度减慢，请使用 hasNext 和 next 方法来搜索这样的模型。

hasNext

tf = hasNext(finder) 确定查找器搜索的容器是否至少包含一个图。如果容器至少有一个图，则 hasNext 方法将该图排队为 next 方法将返回的下一个图。然后 hasNext 方法返回 true。使用 next 方法获取该图。在后续调用中，hasNext 方法确定容器是否具有 next 尚未检索的图。它将图排队以供 next 方法检索并返回 true。如果没有更多图需要检索，此方法将返回 false。要逐步搜索容器中的图，请在 while 循环中使用 hasNext 方法和 next 方法。

注意

如果当前结果是当前模型搜索队列中的最后一个结果，并且 AutoCloseModel 属性为 true，则此方法会在打开下一个模型之前关闭当前模型。虽然这会增加搜索时间，但在搜索引用许多其他模型的顶层模型时，它减少了内存消耗。如果您的模型没有引用许多其他模型，为了加快搜索速度，请将 AutoCloseModel 属性设置为 false 或使用 find 方法。

next

result = next(finder) 返回 hasNext 方法创建的结果队列中的下一个搜索 result。搜索结果包含结果图。将此 result 对象添加到报告或报告器中会为图添加一个图报告器。

示例

全部折叠

查找所有模块图和 Stateflow 图

此示例使用:

打开实时脚本

创建一份包含 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=model_name+" Systems"));

finder = DiagramFinder(model_name); 
while hasNext(finder)
    add(rpt,next(finder));
end    

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

查找子系统中的所有图

此示例使用:

打开实时脚本

打开 sf_car 模型并找到其 Engine 子系统中的所有图。使用子系统的路径或其句柄。然后您可以将结果包含在您的报告中。

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

model_name = "sf_car";
load_system(model_name);

% Use path 
enginePath = "sf_car/Engine";
finder = slreportgen.finder.DiagramFinder(enginePath);
results = find(finder);

% or use handle
engineHandle = get_param("sf_car/Engine","Handle");
finder = slreportgen.finder.DiagramFinder(engineHandle);
results_enginehandle = find(finder);

查找具有特定属性值的图元素

要查找具有特定属性值的元素，请使用 slreportgen.finder.DiagramElementFinder 类的对象。打开 f14 模型并找到所有值为 Zw 的 Gain 模块。

model = 'f14';
openExample(model);
finder = slreportgen.finder.DiagramElementFinder(model)
finder.Properties = {'Gain','Zw'};
results = find(finder);

版本历史记录

在 R2017b 中推出

另请参阅

slreportgen.finder.DiagramFinder 类

描述

创建对象

描述

输入参量

Container — 要搜索的模型容器 路径 | 句柄 | 图 ID | 图对象

属性

Container — 要搜索的模型容器 路径 | 句柄 | 图 ID | 图对象

SearchDepth — 系统图深度搜索 Inf (默认) | 正整数

属性：

IncludeMaskedSubsystems — 搜索封装子系统 true (默认) | false

属性：

IncludeReferencedModels — 搜索模型引用 true (默认) | false

属性：

IncludeReferencedSubsystems — 是否搜索引用子系统 true 或 1 (默认) | false 或 0

IncludeSimulinkLibraryLinks — 搜索 Simulink 库链接 true (默认) | false

属性：

IncludeUserLibraryLinks — 搜索用户库链接 true (默认) | false

属性：

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

属性：

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

属性：

SortType — 查找器结果的排序方法 "none" (默认) | "alphabetical" | "numBlocks" | "depth"

属性：

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

属性：

AutoCloseModel — 是否关闭模型 true (默认) | false

方法

公共方法

示例

查找所有模块图和 Stateflow 图

查找子系统中的所有图

查找具有特定属性值的图元素

版本历史记录

另请参阅

主题

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

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

`SearchDepth` — 系统图深度搜索
`Inf` (默认) | 正整数

`IncludeMaskedSubsystems` — 搜索封装子系统
`true` (默认) | `false`

`IncludeReferencedModels` — 搜索模型引用
`true` (默认) | `false`

`IncludeReferencedSubsystems` — 是否搜索引用子系统
`true` 或 `1` (默认) | `false` 或 `0`

`IncludeSimulinkLibraryLinks` — 搜索 Simulink 库链接
`true` (默认) | `false`

`IncludeUserLibraryLinks` — 搜索用户库链接
`true` (默认) | `false`

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

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

`SortType` — 查找器结果的排序方法
`"none"` (默认) | `"alphabetical"` | `"numBlocks"` | `"depth"`

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

`AutoCloseModel` — 是否关闭模型
`true` (默认) | `false`