mlreportgen.finder.Finder 类

命名空间: mlreportgen.finder

查找器的基类

描述

mlreportgen.finder.Finder 是一个抽象类，它定义了 finder 类所共有的属性和方法。查找器类的对象用于查找可添加到 mlreportgen.report.Report 对象的结果对象。使用 Finder 类或 Finder 类的任何后代作为自定义查找器类的基础。

mlreportgen.finder.Finder 类是一个 handle 类。

类属性

`Abstract`	`true`
`Hidden`	`true`

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

属性

全部展开

`Container` — 需要检查的容器
类型取决于子类的实现

查找器需要搜索的容器。数据类型取决于要搜索的容器的类型。例如，对于变量名，数据类型是字符向量或字符串。

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

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

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

方法

全部展开

公共方法

`find`	`results = find(finder)` 在查找器指定的容器中查找项目。此方法返回在结果对象中找到的项目。这些结果对象可以直接添加到 `mlreportgen.report.Report` 或 `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`。此方法返回它找到的项目，包装在 `mlreportgen.finder.Result` 对象中。要添加项目属性表，请将结果对象直接添加到报告中，或将其添加到报告器中，然后将其添加到报告。可以添加此方法的 `results` 的报告必须为 `mlreportgen.report.Report` 类型。
`isIterating`	`tf = isIterating(finder)` 检查查找器是否正在迭代以查找结果。如果是 `true`，则您无法更改任何查找器属性。
`mustNotBeIterating`	`tf = mustNotBeIterating(finder)` 或 `tf = mustNotBeIterating(finder,propertyName)` 验证查找器没有迭代来查找结果。如果是 `true`，则查找器不得进行迭代，并且您可以更改属性值等。如果是 `false`，查找器正在迭代，您无法更改其属性，等等。可选的 `propertyName` 输入是正在修改并导致错误的属性。
`satisfyObjectPropertiesConstraint`	`tf = satisfyObjectPropertiesConstraint(finder,obj)` 确定 `obj` 是否具有满足查找器指定的 `Properties` 约束的属性。
`reset`	`reset(finder)` 将查找器重置为其初始状态，这样调用 `next(finder)` 会返回第一个结果并重置对象状态。