target.API クラス

パッケージ: target

API の詳細を記述

R2020b 以降

説明

API は、ソフトウェアアプリケーションまたはサービスの操作に関する一連のエントリポイント関数を定義します。target.API オブジェクトを使用して、ターゲット定義に関する API の詳細を提供します。target.APIImplementation を指定してこのクラスを使用し、API を使用してターゲットハードウェアにビルドする方法について記述します。

target.API オブジェクトの作成には関数 target.create を使用します。

プロパティ

すべて展開する

`Name` — API 名
文字ベクトル | string

API の名前。

例: timerApi.Name = 'Linux Timer API';

属性:

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

`Language` — API 言語
`target.Language` オブジェクト

API 実装のプログラミング言語。

属性:

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

`Functions` — API 関数
`target.Function` オブジェクトベクトル

API を構成するエントリポイント関数のセットについて記述する target.Function オブジェクトのベクトル。

属性:

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

例

すべて折りたたむ

`rtiostream` C API の記述

この例では、rtiostream C API の実装の詳細を提供します。

apiImp = target.create('APIImplementation', 'Name', ...
                       'x86 rtiostream Implementation');
apiImp.API = target.create('API', 'Name', 'rtiostream');
apiImp.BuildDependencies = target.create('BuildDependencies');
apiImp.BuildDependencies.SourceFiles = ...
      {fullfile('$(MATLAB_ROOT)', 'toolbox', ...
                'coder', 'rtiostream','src', ...
                'rtiostreamtcpip', 'rtiostream_tcpip.c')};
apiImp.MainFunction = target.create('MainFunction', ...
                      'Name', 'TCP RtIOStream Main');
apiImp.MainFunction.Arguments = {'-blocking', '1', '-port', '0'};