clibgen.LibraryDefinition クラス

名前空間: clibgen

C++ ライブラリの MATLAB 定義

説明

clibgen.LibraryDefinition オブジェクトには、C++ ライブラリに関する情報 (ライブラリにあるクラス、関数、メソッド、プロパティなど) が含まれます。この定義により、MATLAB^® はポインターなどのパラメーターに関する情報を識別できます。

clibgen.LibraryDefinition クラスは handle クラスです。

作成

libdef = LibraryDefinition(dataFile) は、ライブラリ定義オブジェクトを dataFile.xml から作成します。これは clibgen.generateLibraryDefinition コマンドにより作成されたデータ ファイル名です。コンストラクターは、dataFile ファイルが構文的にも意味的にも有効であることを検証します。ファイルが有効でない場合、コンストラクターはエラーをスローします。

入力引数

dataFile — XML ファイル名

string | 文字ベクトル

clibgen.generateLibraryDefinition によって作成される XML ファイル名。string または文字ベクトルとして指定します。名前には拡張子 .xml が含まれます。

プロパティ

OutputFolder — インターフェイス ファイルのフォルダー

string | 文字ベクトル

インターフェイス ファイルのフォルダー。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	public

Libraries — ライブラリ名

string | 文字ベクトル

ライブラリ名。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	public

IncludePath — インクルード フォルダーのパス

string | 文字ベクトル

インクルード フォルダーのパス。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	public

Classes — クラス定義

clibgen.ClassDefinition

ライブラリ内のクラス定義。1 つ以上の clibgen.ClassDefinition オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	private

Enumerations — 列挙型定義

clibgen.EnumDefinition

ライブラリ内の列挙型定義。1 つ以上の clibgen.EnumDefinition オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	private

Functions — 非メンバー関数定義

clibgen.FunctionDefinition

ライブラリ内の非メンバー関数定義。1 つ以上の clibgen.FunctionDefinition オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	private

HeaderFiles — ヘッダー ファイル名

string | 文字ベクトル

ライブラリ インターフェイスで使用するヘッダー ファイル名。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	private

SupportingSourceFiles — C++ ソース ファイル名

string | 文字ベクトル

C++ ソース ファイル名。1 つ以上の string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	private

InterfaceName — MATLAB インターフェイス名前空間

string | 文字ベクトル

R2024a 以降

ライブラリの MATLAB インターフェイス名前空間。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	private

DefinedMacros — マクロ定義

string | 文字ベクトル

ヘッダー ファイルを解析する際に使用するマクロ定義のリスト。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	private

UndefinedMacros — マクロのキャンセル

string | 文字ベクトル

ヘッダー ファイルを解析する際に使用するマクロのキャンセルのリスト。string または文字ベクトルとして指定します。

属性:

GetAccess	public
SetAccess	private

FunctionTypes — 関数タイプの定義

clibgen.FunctionTypeDefinition

ライブラリ内の関数タイプの定義。1 つ以上の clibgen.FunctionTypeDefinition オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	private

OpaqueTypes — typedef void* の定義

clibgen.OpaqueTypeDefinition

ライブラリ内の typedef void* の定義。1 つ以上の clibgen.OpaqueTypeDefinition オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	private

メソッド

パブリック メソッド

addClass	クラスをライブラリ定義に追加
addEnumeration	列挙型をライブラリ定義に追加
addFunction	関数をライブラリ定義に追加
addFunctionType	関数タイプをライブラリ定義に追加
addOpaqueType	ライブラリ定義への opaque 型の追加
copyRuntimeDependencies	Copy run-time libraries to C++ interface library folder
build	ライブラリ インターフェイスの作成
summary	C++ のクラス、関数、enum を MATLAB インターフェイスに表示
validate	ライブラリ定義の検証

バージョン履歴

R2019a で導入

R2024a: PackageName プロパティの名前を InterfaceName に変更

PackageName プロパティの名前が InterfaceName になりました。プロパティの動作は同じままです。このプロパティへの既存の参照のサポートを削除する予定はありません。

参考

clibgen.generateLibraryDefinition