slreportgen.finder.FunctionReferenceResult 类

命名空间: slreportgen.finder
超类: mlreportgen.finder.Result

表示 MATLAB 函数引用的搜索结果对象

自 R2022a 起

全页展开

描述

使用 slreportgen.finder.FunctionReferenceResult 类的对象来报告 slreportgen.finder.FunctionReferenceFinder 对象找到的引用函数。

slreportgen.finder.FunctionReferenceResult 类是 handle 类。

类属性

HandleCompatible true

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

创建对象

您没有明确创建 FunctionReferenceResult 对象。slreportgen.finder.FunctionReferenceFinder 方法 find 和 next 为查找器找到的每个函数引用创建一个 FunctionReferenceResult 对象。

属性

全部展开

公共属性

`Tag` — 用户定义的额外信息
[] (默认) | 字符串标量 | 字符向量 | 对象 | ...

要添加到结果中的用户定义的额外信息，指定为任意值。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`
`NonCopyable`	`true`

受保护的属性

`Object` — 此结果对象所代表的函数的名称
字符串标量

此结果对象所代表的函数的名称，指定为字符串标量。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

数据类型: string

`FunctionType` — 此结果对象表示的函数类型
"built-in" | "user-defined"

此结果对象所表示的函数类型，指定为 "built-in" 或 "user-defined"。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

数据类型: string

`FilePath` — MATLAB^® 程序文件的完整路径
字符串标量

MATLAB 程序文件的完整路径，指定为字符串标量，或者如果 FunctionType 属性为 "built-in" 则指定为空字符串标量。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

数据类型: string

`CallingBlocks` — 引用该函数的模块列表
字符串数组

引用该函数的模块列表，指定为字符串数组。列表中的每个元素对应于 BlockParameters 和 CallingExpressions 属性中具有相同位置索引的元素。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

数据类型: string

`BlockParameters` — 引用调用模块中的函数的参数列表
字符串数组

引用调用模块中的函数的参数列表，指定为字符串数组。列表中的每个元素对应于 CallingBlocks 和 CallingExpressions 属性中具有相同位置索引的元素。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

数据类型: string

`CallingExpressions` — 用于引用调用模块中的函数的表达式列表
字符串数组

用于引用调用模块中的函数的表达式列表，指定为字符串数组。列表中的每个元素对应于 CallingBlocks 和 BlockParameters 属性中具有相同位置索引的元素。

属性：

`GetAccess`	`公共`
`SetAccess`	`受保护`

数据类型: string

方法

全部展开

公共方法

`getReporter`	`funcRefReporter = getReporter(resObj)` 返回与搜索结果对象 `resObj` 关联的 `slreportgen.report.FunctionReference` 报告器。
`getDefaultSummaryTableTitle`	`defTitle = getDefaultSummaryTableTitle(resObj)` 返回类 `FunctionReferenceResult`、`resObj` 的对象的默认摘要表标题。该值是从 `slreportgen.report.SummaryTable` 数组创建的 `FunctionReferenceResult` 对象的默认标题。创建摘要表后，您可以更改标题。
`getDefaultSummaryProperties`	`propList = getDefaultSummaryProperties(resObj)` 返回类 `FunctionReferenceResult`、`resObj` 的对象的默认摘要表属性列表。此方法的返回值 `["Name","Calling Blocks","Calling Expressions"]` 是从 `slreportgen.report.SummaryTable` 数组创建的 `FunctionReferenceResult` 对象的默认属性列表。创建摘要表后，您可以更改其属性。
`getReporterLinkTargetID`	`linkID = getReporterLinkTargetID(resObj)` 返回与结果对象 `resObj` 关联的 `slreportgen.report.FunctionReference` 报告器对象的链接目标 ID。使用 `linkID` 从报告的任何部分创建到函数引用的超链接。
`getPropertyValues`	`propVals = getPropertyValues(resObj,propNames)` 返回搜索结果对象 `propNames` 中 `resObj` 指定的属性值元胞数组。`propVals` 中的条目与 `propNames` 中相同位置索引的条目相对应。与无效条目对应的条目是 `"N/A"`。要检索结果对象的 `Object` 属性的值，请将 `"Object"`、`"Name"` 或 `"Function Name"` 指定为 `propNames` 中的条目。

版本历史记录

在 R2022a 中推出

另请参阅

slreportgen.report.FunctionReference | slreportgen.finder.FunctionReferenceFinder | slreportgen.report.SummaryTable | 报告 Simulink® 模块中的 MATLAB® 函数引用

slreportgen.finder.FunctionReferenceResult 类

描述

类属性

创建对象

属性

公共属性

Tag — 用户定义的额外信息 [] (默认) | 字符串标量 | 字符向量 | 对象 | ...

属性：

受保护的属性

Object — 此结果对象所代表的函数的名称 字符串标量

属性：

FunctionType — 此结果对象表示的函数类型 "built-in" | "user-defined"

属性：

FilePath — MATLAB® 程序文件的完整路径 字符串标量

属性：

CallingBlocks — 引用该函数的模块列表 字符串数组

属性：

BlockParameters — 引用调用模块中的函数的参数列表 字符串数组

属性：

CallingExpressions — 用于引用调用模块中的函数的表达式列表 字符串数组

属性：

方法

公共方法

版本历史记录

另请参阅

`Tag` — 用户定义的额外信息
[] (默认) | 字符串标量 | 字符向量 | 对象 | ...

`Object` — 此结果对象所代表的函数的名称
字符串标量

`FunctionType` — 此结果对象表示的函数类型
"built-in" | "user-defined"

`FilePath` — MATLAB^® 程序文件的完整路径
字符串标量

`CallingBlocks` — 引用该函数的模块列表
字符串数组

`BlockParameters` — 引用调用模块中的函数的参数列表
字符串数组

`CallingExpressions` — 用于引用调用模块中的函数的表达式列表
字符串数组