mlreportgen.finder.Result Class

Namespace: mlreportgen.finder

Base class for finder results

Description

mlreportgen.finder.Result is an abstract class that defines the properties and methods common to finder result classes. Use the Result class, or any descendent of the Result class, as the base for your custom result class.

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

Class Attributes

Abstract	true
Hidden	true

For information on class attributes, see Class Attributes.

Properties

Object — Object represented by result object

type depends on subclass implementation

Object represented by result object. The object type varies depending on the implementation of the subclass.

Attributes:

GetAccess	public
SetAccess	protected
Abstract	true

Tag — Label

[] (default) | any MATLAB^® data type

Label, specified as any MATLAB data type.

Attributes:

GetAccess	public
SetAccess	public
Abstract	true

Methods

Public Methods

getReporterLinkTargetID

linkTargetID = getReporterLinkTargetID(resObj) returns a string that contains the default link target ID for the reporter object associated with the result object, resObj.

Abstract Methods

Concrete subclasses must implement these abstract methods:

getDefaultSummaryTableTitle	defTitle = getDefaultSummaryTableTitle(resObj) returns the default title used by the mlreportgen.report.SummaryTable reporter with the result object, resObj.
getDefaultSummaryProperties	defProps = getDefaultSummaryProperties(resObj) returns a string array of the default list that contains properties reported on by the mlreportgen.report.SummaryTable reporter with the result object, resObj.
getPropertyValues	propVals = getPropertyValues(resObj,propNames) returns a cell array that contains the values of the properties of the result object, resObj specified in the string array propNames.
getReporter	reporterObj = getReporter(resObj) returns the reporter object associated with the result object, resObj.

Version History

Introduced in R2018a