clibgen.LibraryDefinition 类

命名空间: clibgen

用于 C++ 库的 MATLAB 定义

描述

clibgen.LibraryDefinition 对象包含有关 C++ 库的信息，例如库中存在的类、函数、方法和属性。这些定义有助于 MATLAB^® 识别关于参数的信息，如指针。

clibgen.LibraryDefinition 类是一个 handle 类。

创建对象

libdef = LibraryDefinition(dataFile) 基于 dataFile.xml（该数据文件的名称由 clibgen.generateLibraryDefinition 命令创建）创建一个库定义对象。构造函数验证 dataFile 文件在语法和语义上都有效。如果文件无效，则构造函数会抛出错误。

输入参量

全部展开

`dataFile` — XML 文件名
字符串 | 字符向量

XML 文件名，指定为字符串或字符向量，由 clibgen.generateLibraryDefinition 创建。该名称包括扩展名 .xml。

属性

全部展开

`OutputFolder` — 接口文件的文件夹
字符串 | 字符向量

用来存放接口文件的文件夹，指定为字符串或字符向量。

属性：

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

`Libraries` — 库名称
字符串 | 字符向量

库名称，指定为字符串或字符向量。

属性：

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

`IncludePath` — include 文件夹的路径
字符串 | 字符向量

include 文件夹的路径，指定为字符串或字符向量。

属性：

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

`Classes` — 类定义
`clibgen.ClassDefinition`

库中的类定义，指定为一个或多个 clibgen.ClassDefinition 对象。

属性：

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

`Enumerations` — 枚举定义
`clibgen.EnumDefinition`

库中的枚举定义，指定为一个或多个 clibgen.EnumDefinition 对象。

属性：

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

`Functions` — 非成员函数定义
`clibgen.FunctionDefinition`

库中的非成员函数定义，指定为一个或多个 clibgen.FunctionDefinition 对象。

属性：

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

`HeaderFiles` — 头文件名
字符串 | 字符向量

要在库接口中使用的头文件名，指定为字符串或字符向量。

属性：

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

`SupportingSourceFiles` — C++ 源文件名
字符串 | 字符向量

C++ 源文件名，指定为一个或多个字符串或字符向量。

属性：

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

`InterfaceName` — MATLAB 接口命名空间
字符串 | 字符向量

自 R2024a 起

库的 MATLAB 接口命名空间，指定为字符串或字符向量。

属性：

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

`DefinedMacros` — 宏定义
字符串 | 字符向量

解析头文件时要使用的宏定义列表，指定为字符串或字符向量。

属性：

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

`UndefinedMacros` — 宏取消
字符串 | 字符向量

解析头文件时要使用的宏取消列表，指定为字符串或字符向量。

属性：

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

`FunctionTypes` — 函数类型的定义
`clibgen.FunctionTypeDefinition`

库中函数类型的定义，指定为一个或多个 clibgen.FunctionTypeDefinition 对象。

属性：

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

`OpaqueTypes` — `typedef void*` 的定义
`clibgen.OpaqueTypeDefinition`

库中的 typedef void* 定义，指定为一个或多个 clibgen.OpaqueTypeDefinition 对象。

属性：

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

方法

全部展开

公共方法

`addClass`	将类添加到库定义
`addEnumeration`	将枚举添加到库定义
`addFunction`	将函数添加到库定义
`addFunctionType`	向库定义添加函数类型
`addOpaqueType`	向库定义添加不透明类型
`copyRuntimeDependencies`	Copy run-time libraries to C++ interface library folder
`build`	构建库接口
`summary`	在 MATLAB 界面中显示 C++ 类、函数和枚举
`validate`	验证库定义

版本历史记录

在 R2019a 中推出

全部展开

R2024a: `PackageName` 属性重命名为 `InterfaceName`

PackageName 属性的名称现在是 InterfaceName。该属性的行为保持不变。目前没有停止支持对该属性的现有引用的计划。

另请参阅

clibgen.generateLibraryDefinition

clibgen.LibraryDefinition 类

描述

创建对象

输入参量

dataFile — XML 文件名 字符串 | 字符向量

属性

OutputFolder — 接口文件的文件夹 字符串 | 字符向量

属性：

Libraries — 库名称 字符串 | 字符向量

属性：

IncludePath — include 文件夹的路径 字符串 | 字符向量

属性：

Classes — 类定义 clibgen.ClassDefinition

属性：

Enumerations — 枚举定义 clibgen.EnumDefinition

属性：

Functions — 非成员函数定义 clibgen.FunctionDefinition

属性：

HeaderFiles — 头文件名 字符串 | 字符向量

属性：

SupportingSourceFiles — C++ 源文件名 字符串 | 字符向量

属性：

InterfaceName — MATLAB 接口命名空间 字符串 | 字符向量

属性：

DefinedMacros — 宏定义 字符串 | 字符向量

属性：

UndefinedMacros — 宏取消 字符串 | 字符向量

属性：

FunctionTypes — 函数类型的定义 clibgen.FunctionTypeDefinition

属性：

OpaqueTypes — typedef void* 的定义 clibgen.OpaqueTypeDefinition

属性：

方法

公共方法

版本历史记录

R2024a: PackageName 属性重命名为 InterfaceName

另请参阅

`dataFile` — XML 文件名
字符串 | 字符向量

`OutputFolder` — 接口文件的文件夹
字符串 | 字符向量

`Libraries` — 库名称
字符串 | 字符向量

`IncludePath` — include 文件夹的路径
字符串 | 字符向量

`Classes` — 类定义
`clibgen.ClassDefinition`

`Enumerations` — 枚举定义
`clibgen.EnumDefinition`

`Functions` — 非成员函数定义
`clibgen.FunctionDefinition`

`HeaderFiles` — 头文件名
字符串 | 字符向量

`SupportingSourceFiles` — C++ 源文件名
字符串 | 字符向量

`InterfaceName` — MATLAB 接口命名空间
字符串 | 字符向量

`DefinedMacros` — 宏定义
字符串 | 字符向量

`UndefinedMacros` — 宏取消
字符串 | 字符向量

`FunctionTypes` — 函数类型的定义
`clibgen.FunctionTypeDefinition`

`OpaqueTypes` — `typedef void*` 的定义
`clibgen.OpaqueTypeDefinition`

R2024a: `PackageName` 属性重命名为 `InterfaceName`