clibgen.EnumDefinition 类

命名空间: clibgen

对应于 C++ 枚举的 MATLAB 枚举的定义

全页展开

描述

clibgen.EnumDefinition 类包含在 C++ 头文件中定义的枚举的 MATLAB^® 定义。

clibgen.EnumDefinition 类是一个 handle 类。

创建对象

当 MATLAB 对 clibgen.LibraryDefinition 对象调用 addEnumeration 时，MATLAB 会构造一个 EnumDefinition 对象。

属性

全部展开

`Description` — 帮助文本
字符串 | 字符向量

最终用户用于描述枚举的帮助文本，指定为字符串或字符向量。默认文本是：

MATLABName    Representation of C++ enumeration CPPName.

发布者可以在库定义文件中修改 Description 属性的值。

示例: C++ 枚举 COLOR 的 clib.cppSample.COLOR 表示。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`DetailedDescription` — C++ 头文件中的帮助文本
字符串 | 字符向量 | 空字符串

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

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

This content is from the external library documentation.

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`DefiningLibrary` — 定义枚举的库
`clibgen.LibraryDefinition`

定义枚举的库，指定为 clibgen.LibraryDefinition 对象。

示例: myFonts

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`CPPName` — C++ 枚举名称
字符串 | 字符向量

C++ 枚举名称，指定为字符串或字符向量。MATLAB 基于头文件中的 enum class 名称创建 CPPName。

示例: COLOR

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`MATLABType` — MATLAB 类型
`int32`

枚举值的 MATLAB 类型，指定为 int32。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`Valid` — 定义完整指示符
`false` (默认) | `true`

指示枚举定义是否完整，指定为 true 或 false。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`MATLABName` — MATLAB 中的 C++ 枚举名称
字符串 | 字符向量

MATLAB 中的 C++ 枚举名称，指定为字符串或字符向量。

示例: clib.MySpace.COLOR

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`Entries` — 枚举
结构体

枚举，指定为由枚举值和说明有关枚举的详细信息的头文件中的可选 C++ 注释组成的结构体。MATLAB 基于头文件中的 enum class 定义创建 Entries。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

提示

您可能需要在 MATLAB 中创建一个枚举值，但该值的名称可能不是有效的 MATLAB 名称。例如，枚举名称可能以下划线开头。要在运行时从该名称派生一个值，请使用以下 MATLAB 语法，其中 enumMember 是字符串标量或字符向量，它在计算后返回枚举的实例。
```
clib.libName.enumName.(enumMember)
```
例如，假设您的接口 clib.enums.keywords 具有以下属性：
```
  EnumDefinition with properties:

        Description: "clib.enums.keywords    Representation of C++ enumeration"
    DefiningLibrary: [1×1 clibgen.LibraryDefinition]
            CPPName: "keywords"
         MATLABType: "int32"
              Valid: 1
         MATLABName: "clib.enums.keywords"
            Entries: ["_for"    "_while"    "_class"    "_enums"    "_template"    "_typename"]
```
要将项 _class 赋给变量，请键入：
```
var = clib.enums.keywords.('_class');
```
此语法对于小于最大标识符长度 namelengthmax 的名称有效。
要读取在 MATLAB 中创建的 C++ 枚举对象的基础数值，请调用 underlyingValue。

版本历史记录

在 R2019a 中推出

另请参阅

clibgen.LibraryDefinition | underlyingValue | addEnumeration

clibgen.EnumDefinition 类

描述

创建对象

属性

Description — 帮助文本 字符串 | 字符向量

属性：

DetailedDescription — C++ 头文件中的帮助文本 字符串 | 字符向量 | 空字符串

属性：

DefiningLibrary — 定义枚举的库 clibgen.LibraryDefinition

属性：

CPPName — C++ 枚举名称 字符串 | 字符向量

属性：

MATLABType — MATLAB 类型 int32

属性：

Valid — 定义完整指示符 false (默认) | true

属性：

MATLABName — MATLAB 中的 C++ 枚举名称 字符串 | 字符向量

属性：

Entries — 枚举 结构体

属性：

提示