Main Content

slreportgen.finder.FunctionReferenceResult class

Package: slreportgen.finder
Superclasses: mlreportgen.finder.Result

Search result object that represents a MATLAB function reference

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

expand all

Optional label, specified as any type of MATLAB® variable.

Attributes:

GetAccess
public
SetAccess
public

Function Properties

Properties that describe the referenced function.

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

Attributes:

GetAccess
public
SetAccess
protected

Data Types: string

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

Attributes:

GetAccess
public
SetAccess
protected

Data Types: string

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

References Properties

Properties that describe the references to the function, specified each as a string array. Elements in these arrays correspond to each other.

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

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

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

expand all

Version History

Introduced in R2022a