本页采用了机器翻译。点击此处可查看最新英文版本。

mlreportgen.finder.MATLABVariableResult 类

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

MATLAB 变量搜索结果对象

自 R2022a 起

全页展开

描述

mlreportgen.finder.MATLABVariableResult 类的对象是搜索 MATLAB® 变量的结果。MATLABVariableResult 对象包含有关单个变量的信息。每个 MATLABVariableResult 对象都与代表相同 MATLAB 变量的 mlreportgen.report.MATLABVariable 报告器对象相关联。要报告变量，请将 MATLABVariableResult 对象添加到生成的报告中。

mlreportgen.finder.MATLABVariableResult 类是一个 handle 类。

类属性

HandleCompatible
true

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

创建对象

您没有明确创建 MATLABVariableResult 对象。MATLABVariableFinder 方法 find 和 next 为它们找到的每个变量创建一个 MATLABVariableResult 对象。

属性

全部展开

此 MATLABVariableResult 对象所代表的变量的名称，以字符串标量的形式返回。

属性

GetAccess
public
SetAccess
protected

数据类型: string

定义变量的工作区，指定为以下值之一：

值工作区
"MATLAB"基础工作区
"Global"全局工作区
"MAT-File" MAT 文件

属性

GetAccess
public
SetAccess
限制访问

数据类型: string

定义变量的 MAT 文件的名称，指定为字符串标量。如果该变量未在 MAT 文件中定义，则 FileName 为空。

属性

GetAccess
public
SetAccess
限制访问

数据类型: string

可选标记，指定为任何类型的 MATLAB 变量。

属性

GetAccess
public
SetAccess
public

方法

全部展开

示例

全部折叠

打开实时脚本

此示例显示如何将包含有关 MATLAB® 变量的信息的摘要表添加到报告。

导入这些包，这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*
import mlreportgen.finder.*
import mlreportgen.dom.*

在基础工作区中定义不同数据类型和大小的变量和全局变量。

global gvar_string gvar_str_arr_2x3 gvar_uint8_arr_9x3;
gvar_string = "this is my string scalar variable";
gvar_str_arr_2x3 = ...
    ["str 1.1","str 1.2","str 1.3";"str 2.1","str 2.2","str 2.3"];
gvar_uint8_arr_9x3 = uint8(randi(255,9,3));

var_char_arr = 'this is my character vector variable';
var_double_3x5x6 = rand(3,5,6);
var_cell_arr_7x8x9 = num2cell(rand(7,8,9));

创建 PDF 类型的 mlreportgen.report.Report 对象。然后创建一个标题并将其追加到 Report 对象。

rpt = Report("Summary_of_variables_example","pdf");
docHeader = Heading(1,"Summary of variables we found:");
append(rpt,docHeader);

使用 mlreportgen.finder.MATLABVariableFinder.find 方法在基础工作区中查找变量，并创建代表变量的 mlreportgen.finder.MATLABVariableResult 对象数组。

results = find(MATLABVariableFinder());

使用结果数组创建一个 mlreportgen.report.SummaryTable 对象。表的默认标题是 getDefaultSummaryTableTitle 方法的返回值，表中要报告的属性的默认列表是 getDefaultSummaryProperties 方法的返回值。保持表标题和表中要报告的属性列表不变。

table1 = SummaryTable(results);

使用结果数组创建第二个 SummaryTable 对象。然后设置这张表的标题为 "global or not"，并设置这张表要上报的属性为 "Name" 和 "Global"。

table2 = SummaryTable(results);
table2.Title = "global or not";
table2.Properties = ["Name","Global"];

将两个汇摘要表追加到报告中。然后关闭并查看报告。

append(rpt,table1);
append(rpt,table2);
close(rpt);
rptview(rpt);
打开实时脚本

此示例显示如何在报告中创建指向变量的超链接。

导入这些包，这样您就不必使用长而完全限定的类名。

import mlreportgen.report.*
import mlreportgen.finder.*
import mlreportgen.dom.*

在基础工作区中定义变量。

for index = 1:99
  evalin("base",sprintf(...
      "var_%0.3i='this is the content of var_%0.2i';",index,index));
end

创建 HTML 类型的 mlreportgen.report.Report 对象。然后创建一个标题并将其追加到 Report 对象。

rpt = Report("MATLABVariableResult_hyperlink_Example","html-file");
header = Heading(1,"These are the variables we found:");
append(rpt,header);

使用 mlreportgen.finder.MATLABVariableFinder.find 方法在基础工作区中查找名称以 "var" 开头的变量，并创建一个代表这些变量的 mlreportgen.finder.MATLABVariableResult 对象向量。然后将结果对象追加到报告中。

results = find(MATLABVariableFinder(Name="^var",Regexp=true));
append(rpt,results);

创建一个链接目标 ID 为结果编号 31 的 mlreportgen.dom.InternalLink 对象。然后将 InternalLink 对象追加到报告中。

targetID = getReporterLinkTargetID(results(31));
link = InternalLink(targetID,"Jump to result #31");
append(rpt,link);

关闭并查看报告。

close(rpt);
rptview(rpt);

滚动到报告底部来测试超链接。

版本历史记录

在 R2022a 中推出

另请参阅

| |