Main Content

clibgen.PropertyDefinition 类

命名空间: clibgen

对应于 C++ 类的公共属性的 MATLAB 属性定义

描述

clibgen.PropertyDefinition 类包含 C++ 类的头文件中定义的公共属性的 MATLAB® 定义。

clibgen.PropertyDefinition 类是一个 handle 类。

创建对象

当 MATLAB 对 clibgen.ClassDefinition 对象调用 addProperty 时,MATLAB 会构造一个 PropertyDefinition 对象。

属性

全部展开

最终用户用于描述属性的帮助文本,指定为字符串或字符向量。默认文本是:

MATLABType    Data member of C++ class DefiningClass.CPPName.
发布者可以在库定义文件中修改 Description 属性的值。

示例: C++ 类 MyClass 的双精度数据成员。

属性:

GetAccess
public
SetAccess
public

最终用户用于描述关于属性的详细信息的 C++ 头文件中的帮助文本,指定为字符串或字符向量。如果 C++ 注释不包含详细信息,则 DetailedDescription 不会出现在定义文件中。

发布者可以在库定义文件中修改 DetailedDescription 属性的值。如果 DetailedDescription 不为空,则 MATLAB doc 命令会在显示 DetailedDescription 的值之前显示以下句子。

This content is from the external library documentation.

属性:

GetAccess
public
SetAccess
public

C++ 属性名称,指定为字符串或字符向量。MATLAB 基于头文件中的类公共数据成员创建 CPPName

属性:

GetAccess
public
SetAccess
private

包含属性的类,指定为 clibgen.ClassDefinition 对象。

属性:

GetAccess
public
SetAccess
private

MATLAB 中的类型,指定为字符串或字符向量。MATLAB 根据头文件中类公共数据成员的定义创建 MATLABType

属性:

GetAccess
public
SetAccess
private

提示

  • 您可能需要访问 MATLAB 中的某个属性,但该属性的名称可能不是有效的 MATLAB 名称。例如,该名称可能以下划线开头。要在运行时派生此名称,请使用以下 MATLAB 语法,其中 propertyName 是字符串标量或字符向量,它在计算后返回属性的实例。

    clib.libName.className.(propertyName)

    例如,假设您的接口 clib.demo.MyClass 具有以下属性:

    class MyClass
    {
    public:
        int _mean;
    };
    

    要将属性 _mean 赋给变量,请键入:

    x = clib.demo.MyClass;
    xmean = x.('_mean')

    此语法对于小于最大标识符长度 namelengthmax 的名称有效。

版本历史记录

在 R2019a 中推出