Main Content

mlreportgen.finder.Finder class

Package: mlreportgen.finder

Base class for finders

Description

mlreportgen.finder.Finder is an abstract class that defines the properties and methods common to finder classes. Objects of finder classes are used to find result objects that can be added to an mlreportgen.report.Report object. Use the Finder class, or any descendent of the Finder class, as the base for your custom finder class.

The mlreportgen.finder.Finder class is a handle class.

Class Attributes

Abstract
true
Hidden
true

For information on class attributes, see Class Attributes.

Properties

expand all

Container to be searched by the finder. The data type depends on the type of container to be searched. For example, for a variable name, the data type is a character vector or string.

Properties of objects to find, specified as a cell array of name-value pairs. The finder returns only objects that have the specified properties with the specified values.

Example: finder.Properties = {'Gain','5'}

Methods

expand all

Version History

Introduced in R2018a