slreportgen.report.FunctionReference 类

命名空间: slreportgen.report
超类: slreportgen.report.Reporter

MATLAB 函数引用的报告器

自 R2022a 起

描述

使用 slreportgen.report.FunctionReference 类的对象来报告专门用于计算 MATLAB^® 模块中的参数的 Simulink^® 函数引用。您可以使用 FunctionReference 对象将这些元素添加到您的报告中：

包含有关模型模块如何引用该函数的详细信息的表格
包含有关函数类型信息的节
包含有关定义该函数的 MATLAB 程序文件 (.m) 的信息的节

slreportgen.report.FunctionReference 类是 handle 类。

类属性

HandleCompatible true

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

创建对象

您没有明确创建 FunctionReference 对象。要创建 FunctionReference 对象，请将 getReporter 方法与 slreportgen.finder.FunctionReferenceResult 类的对象一起使用。

属性

全部展开

`Object` — 需要报告的 MATLAB 函数
`slreportgen.finder.FunctionReferenceResult` 对象

要报告的 MATLAB 函数，指定为 slreportgen.finder.FunctionReferenceResult 对象。

属性：

`GetAccess`	`公共`
`SetAccess`	`私有`

数据类型: slreportgen.finder.FunctionReferenceResult

`ParagraphFormatter` — 标签、函数文件路径和函数类型文本的格式化程序
`mlreportgen.dom.Paragraph` 对象

标签、函数文件路径和函数类型文本的格式化程序，指定为 mlreportgen.dom.Paragraph 对象。如果包含在报告中，此格式化程序将确定所有标签、函数类型文本和函数文件路径的呈现。要自定义这些元素的渲染，请自定义现有的 Paragraph 对象或分配并自定义新的 Paragraph 对象。

注意

如果 FunctionFileDisplayPolicy 是 "code"，则此属性仅影响函数代码节的标签。使用 MATLABCodeReporter 属性自定义函数代码的外观。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: mlreportgen.dom.Paragraph

`ShowFunctionType` — 是否在报告中包含函数类型
`true` 或 `1` (默认) | `false` 或 `0`

是否在报告中包含函数类型，指定为逻辑值 1 (true) 或 0 (false)。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: logical

引用表

与引用表相关的属性，其中包含有关引用该函数的模块的信息。

`ShowReferencesTable` — 是否在报告中包含引用表
`true` 或 `1` (默认) | `false` 或 `0`

是否在报告中包含引用表，指定为逻辑值 1 (true) 或 0 (false)。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: logical

`Title` — 引用表标题
空字符串 (默认) | 字符数组 | 字符串标量 | `mlreportgen.dom` 对象

如果报告中含有引用表的标题，则指定为以下值之一：

值	描述
空的 0x0 字符串	默认标题，格式为 `<function name> References`
字符向量或字符串标量	表格的明确标题
`mlreportgen.dom.Text` 对象	`Text` 对象的 `Content` 属性的值
`mlreportgen.dom.InternalLink` 对象	`InternalLink` 对象的 `Children` 属性中对象内容的串联
`mlreportgen.dom.InternalLink` 对象	`ExternalLink` 对象的 `Children` 属性中对象内容的串联

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string | mlreportgen.dom.Text | mlreportgen.dom.InternalLink | mlreportgen.dom.ExternalLink

`TableReporter` — 引用表的格式化程序
`mlreportgen.report.BaseTable` 对象

如果包含在报告中，则引用表的格式化程序指定为 mlreportgen.report.BaseTable 对象。该属性的默认值是 BaseTable 对象，其 TableStyleName 属性设置为 FunctionReferenceTable 样式，该样式在 FunctionReference 报告器的默认模板中定义。要自定义引用表，请自定义现有的 BaseTable 对象或分配并自定义新的 BaseTable 对象。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: mlreportgen.report.BaseTable

程序文件

与定义引用函数的 MATLAB 程序文件 (.m) 的信息的节相关的属性。

`ShowFunctionFile` — 是否包含 MATLAB 程序文件的信息
`true` 或 `1` (默认) | `false` 或 `0`

是否包含有关 MATLAB 程序文件的信息，指定为逻辑值 1 (true) 或 0 (false)。FunctionFileDisplayPolicy 的值决定要包含有关文件的哪些信息，文件内容还是文件路径。仅对用户定义的函数有效。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: logical

`FunctionFileDisplayPolicy` — 是否包含 MATLAB 程序文件的内容或路径
`"code"` (默认) | `"text"`

确定是否包含 MATLAB 程序文件的内容或路径，指定为以下值之一：

值	描述
`"code"`	包含 MATLAB 程序文件的内容
`"text"`	包含 MATLAB 程序文件的路径

仅对用户定义的函数有效。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: char | string

`MATLABCodeReporter` — MATLAB 程序文件代码的格式化程序
`mlreportgen.report.MATLABCode` 对象

MATLAB 程序文件代码的格式化程序（如果包含在报告中）指定为 mlreportgen.report.MATLABCode 对象。要自定义报告中代码的格式，请自定义现有的 MATLABCode 对象或分配并自定义新的 MATLABCode 对象。

属性：

`GetAccess`	`公共`
`SetAccess`	`公共`

数据类型: mlreportgen.report.MATLABCode

方法

全部展开

公共方法

`slreportgen.report.FunctionReference.getClassFolder`	`folderPath = getClassFolder` 返回包含 `slreportgen.report.FunctionReference` 类定义文件的文件夹的路径。
`slreportgen.report.FunctionReference.getDefaultTemplatePath`	`templatePath = getDefaultTemplatePath(reporterObj,templateType)` 为 `FunctionReference`、`reporterObj` 类的对象返回指定类型的默认模板文件的路径。

`copy`	创建 Simulink 报告器对象的副本并对某些属性值进行深度复制
`getImpl`	获取报告器的实施
`slreportgen.report.FunctionReference.createTemplate`	复制 `slreportgen.report.FunctionReference` 类的模板文件
`slreportgen.report.FunctionReference.customizeReporter`	创建自定义函数引用报告器类

版本历史记录

在 R2022a 中推出

另请参阅

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

slreportgen.report.FunctionReference 类

描述

类属性

创建对象

属性

Object — 需要报告的 MATLAB 函数 slreportgen.finder.FunctionReferenceResult 对象

属性：

ParagraphFormatter — 标签、函数文件路径和函数类型文本的格式化程序 mlreportgen.dom.Paragraph 对象

属性：

ShowFunctionType — 是否在报告中包含函数类型 true 或 1 (默认) | false 或 0

属性：

引用表

ShowReferencesTable — 是否在报告中包含引用表 true 或 1 (默认) | false 或 0

属性：

Title — 引用表标题 空字符串 (默认) | 字符数组 | 字符串标量 | mlreportgen.dom 对象

属性：

TableReporter — 引用表的格式化程序 mlreportgen.report.BaseTable 对象

属性：

程序文件

ShowFunctionFile — 是否包含 MATLAB 程序文件的信息 true 或 1 (默认) | false 或 0

属性：

FunctionFileDisplayPolicy — 是否包含 MATLAB 程序文件的内容或路径 "code" (默认) | "text"

属性：

MATLABCodeReporter — MATLAB 程序文件代码的格式化程序 mlreportgen.report.MATLABCode 对象

属性：

方法

公共方法

版本历史记录

另请参阅

`Object` — 需要报告的 MATLAB 函数
`slreportgen.finder.FunctionReferenceResult` 对象

`ParagraphFormatter` — 标签、函数文件路径和函数类型文本的格式化程序
`mlreportgen.dom.Paragraph` 对象

`ShowFunctionType` — 是否在报告中包含函数类型
`true` 或 `1` (默认) | `false` 或 `0`

`ShowReferencesTable` — 是否在报告中包含引用表
`true` 或 `1` (默认) | `false` 或 `0`

`Title` — 引用表标题
空字符串 (默认) | 字符数组 | 字符串标量 | `mlreportgen.dom` 对象

`TableReporter` — 引用表的格式化程序
`mlreportgen.report.BaseTable` 对象

`ShowFunctionFile` — 是否包含 MATLAB 程序文件的信息
`true` 或 `1` (默认) | `false` 或 `0`

`FunctionFileDisplayPolicy` — 是否包含 MATLAB 程序文件的内容或路径
`"code"` (默认) | `"text"`

`MATLABCodeReporter` — MATLAB 程序文件代码的格式化程序
`mlreportgen.report.MATLABCode` 对象