slreportgen.finder.FunctionReferenceResult Class

Namespace: slreportgen.finder
Superclasses: mlreportgen.finder.Result

Search result object that represents a MATLAB function reference

Since R2022a

Description

Use objects of the class slreportgen.finder.FunctionReferenceResult to report on a referenced function found by an slreportgen.finder.FunctionReferenceFinder object.

The slreportgen.finder.FunctionReferenceResult class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

You do not create FunctionReferenceResult objects explicitly. The slreportgen.finder.FunctionReferenceFinder methods find and next create a FunctionReferenceResult object for each function reference the finder finds.

Properties

Public Properties

Tag — Additional user-defined information

[] (default) | string scalar | character vector | object | ...

Additional user-defined information to add to the result, specified as any value.

Attributes:

NonCopyable

true

Protected Properties

Object — Name of function represented by this result object

string scalar

Name of the function represented by this result object, specified as a string scalar.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

FunctionType — Type of function represented by this result object

"built-in" | "user-defined"

Type of function represented by this result object, specified as "built-in" or "user-defined".

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

FilePath — Full path of MATLAB^® program file

string scalar

Full path of the MATLAB program file, specified as a string scalar, or an empty string scalar if the FunctionType property is "built-in".

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

CallingBlocks — List of blocks that reference the function

string array

List of blocks that reference the function, specified as a string array. Each element in the list corresponds to the elements with the same positional index in the BlockParameters and CallingExpressions properties.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

BlockParameters — List of parameters that reference the function in the calling blocks

string array

List of parameters that reference the function in the calling blocks, specified as a string array. Each element in the list corresponds to the elements with the same positional index in the CallingBlocks and CallingExpressions properties.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

CallingExpressions — List of expressions used to reference the function in the calling blocks

string array

List of expressions used to reference the function in the calling blocks, specified as a string array. Each element in the list corresponds to the elements with the same positional index in the CallingBlocks and BlockParameters properties.

Attributes:

GetAccess	public
SetAccess	protected

Data Types: string

Methods

Public Methods

getReporter	funcRefReporter = getReporter(resObj) returns the slreportgen.report.FunctionReference reporter that is associated with the search result object, resObj.
getDefaultSummaryTableTitle	defTitle = getDefaultSummaryTableTitle(resObj) returns the default summary table title for an object of the class FunctionReferenceResult, resObj. This value is the default title for an slreportgen.report.SummaryTable object created from a FunctionReferenceResult array. After you create a summary table, you can change the title.
getDefaultSummaryProperties	propList = getDefaultSummaryProperties(resObj) returns the list of default summary table properties for an object of the class FunctionReferenceResult, resObj. The return value of this method, ["Name","Calling Blocks","Calling Expressions"], is the list of default properties for an slreportgen.report.SummaryTable object created from a FunctionReferenceResult array. After you create a summary table, you can change the properties.
getReporterLinkTargetID	linkID = getReporterLinkTargetID(resObj) returns the link target ID of the slreportgen.report.FunctionReference reporter object associated with the result object, resObj. Use linkID to create a hyperlink from any part of the report to the function reference.
getPropertyValues	propVals = getPropertyValues(resObj,propNames) returns a cell array of the values of the properties specified by propNames in the search result object resObj. Entries in propVals correspond to entries in propNames in the same positional indices. Entries that correspond to invalid entries are "N/A". To retrieve the value of the Object property of the result object, specify "Object", "Name", or "Function Name" as an entry in propNames.

Version History

Introduced in R2022a