clibgen.FunctionDefinition クラス
名前空間: clibgen
C++ パッケージ関数に対応する MATLAB 関数の定義
説明
clibgen.FunctionDefinition
クラスには、C++ ヘッダーで定義されている関数の MATLAB® 定義が含まれます。
clibgen.FunctionDefinition
クラスは handle
クラスです。
作成
MATLAB が addFunction
を clibgen.LibraryDefinition
オブジェクトで呼び出すときに、MATLAB が FunctionDefinition
オブジェクトを構築します。
プロパティ
Description
— ヘルプ テキスト
string | 文字ベクトル
パッケージ関数についてエンド ユーザーに説明するヘルプ テキスト。string または文字ベクトルとして指定します。パブリッシャーはライブラリ定義ファイルで Description
プロパティの値を変更できます。
例: C++ 関数 charInput
の clib.cppSample.charInput
表現。
属性:
GetAccess | public |
SetAccess | public |
DetailedDescription
— C++ ヘッダー ファイルからのヘルプ テキスト
string | 文字ベクトル | 空の string
パッケージ関数についてエンド ユーザーに説明する C++ ヘッダー ファイルからのヘルプ テキスト。string または文字ベクトルとして指定します。C++ コメントに詳細情報が含まれない場合、DetailedDescription
は定義ファイルに表示されません。
パブリッシャーはライブラリ定義ファイルで DetailedDescription
プロパティの値を変更できます。DetailedDescription
が空でない場合、DetailedDescription
の値を表示する前に MATLAB doc
コマンドにこの文章が表示されます。
This content is from the external library documentation.
属性:
GetAccess | public |
SetAccess | public |
CPPSignature
— C++ 関数シグネチャ
string | 文字ベクトル
C++ 関数シグネチャ。string または文字ベクトルとして指定します。MATLAB はヘッダー ファイルの関数定義から CPPSignature
を作成します。
例: void intInput(int * ptr,int len)
属性:
GetAccess | public |
SetAccess | private |
DefiningLibrary
— 関数を含むライブラリ
clibgen.LibraryDefinition
MATLABName
— MATLAB の C++ 関数名
string | 文字ベクトル
MATLAB の C++ 関数名。string または文字ベクトルとして指定します。
属性:
GetAccess | public |
SetAccess | private |
MATLABSignature
— MATLAB の関数シグネチャ
string | 文字ベクトル
MATLAB の関数シグネチャ。string または文字ベクトルとして指定します。MATLAB はこのシグネチャを作成します。
属性:
GetAccess | public |
SetAccess | private |
Dependent | true |
Valid
— 定義完了インジケーター
false
(既定値) | true
関数の定義が完了しているかどうかを示します。true
または false
として指定されます。
属性:
GetAccess | public |
SetAccess | private |
TemplateUniqueName
— 推奨関数名
string | 文字ベクトル
関数のオーバーロードがある場合、テンプレートから導出される関数の推奨関数名。string または文字ベクトルとして指定します。
例: "clib.libname.task_int_"
属性:
GetAccess | public |
SetAccess | private |
メソッド
パブリック メソッド
defineArgument | C++ パッケージ関数の入力引数の定義を追加 |
defineOutput | C++ パッケージ関数の出力引数の定義の追加 |
validate | 関数定義の検証 |
バージョン履歴
R2019a で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)