主要内容

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

getPropertyValues

类: mlreportgen.finder.MATLABVariableResult
命名空间: mlreportgen.finder

获取 MATLAB 变量搜索结果对象的属性值

自 R2022a 起

说明

propVals = getPropertyValues(resObj,propNames) 返回 MATLAB® 变量搜索结果对象 propNamesresObj 指定的属性的值。指定的属性可以属于结果对象,也可以属于结果对象所表示的变量。

输入参数

全部展开

MATLAB 变量搜索结果,指定为 mlreportgen.finder.MATLABVariableResult 对象。

所请求属性的列表,指定为字符串数组或字符串元胞数组。数组中元素的有效值可以按任意顺序排列:

请求的属性返回值
"Name"变量的名称,指定为字符串标量
"Class"变量的数据类型,指定为字符向量
"Size"变量的维度,指定为双精度数组
"Bytes"用于在计算机内存中存储变量的字节数,指定为双精度标量
"Sparse"变量是否为稀疏矩阵,指定为逻辑
"Complex"变量是否为复数,指定为逻辑
"Value"变量的值
"Global"变量是否为全局变量,指定为逻辑
resObj 的任何属性的名称属性的值
resObj 的任何属性的名称,可以通过点符号访问。注意:此选项仅适用于 struct 类型的变量或类实例的变量。属性的值

注意

如果 resObj 表示的变量具有与 resObj 的属性同名的属性,则方法 getPropertyValues 将检索 resObj 的属性值。例如:

  1. 在基础工作区中,定义一个 struct,其中包含一个名为 Place 的字段和一个名为 Location 的字段。

    myStruct.Place = "USA";
    myStruct.Location = "America";
    

  2. 使用 find 方法为结构体 myStruct 创建 MATLABVariableResult 对象。

    resObj = find(mlreportgen.finder.MATLABVariableFinder(...
                                  Container="MATLAB",Name="myStruct"));
    

  3. 使用 getPropertyValues 方法获取 PlaceLocation 属性的值。

    getPropertyValues(resObj,["Place","Location"])
    

    Location 属性的值是从 resObj"MATLAB"

    ans =
    
      1×2 cell array
    
        {["USA"]}    {["MATLAB"]}
    

输出参量

全部展开

指定属性的值,以元胞数组形式返回。

版本历史记录

在 R2022a 中推出