getFunction

モデル関数に対するコードマッピングからのコード構成の取得

R2020b 以降

構文

propertyValue = getFunction(coderMapObj,modelFunc,funcProperty)

説明

propertyValue = getFunction(coderMapObj,modelFunc,funcProperty) は指定されたモデル関数に対するプロパティの値を返します。この関数を使用して、モデル関数に対して構成された関数カスタマイズテンプレートまたはメモリセクションを返します。以前に引数仕様を設定したシングルタスクの周期関数と Simulink 関数については、この関数を使用して引数仕様を返します。

例

すべて折りたたむ

Simulink $^{®}$ モデルのコードマッピングの関数プロパティのプログラムによる取得および設定

ライブスクリプトを開く

プログラムインターフェイスを使用して、Simulink モデルのコードマッピング内の関数のプロパティを取得および構成します。

コマンドが [コードマッピング] エディターにどのように反映されるかを対話的に確認するには、[Functions] タブが選択された状態で [コードマッピング] エディターが開いていることを確認してください。[コードマッピング] エディターを開く方法については、コードマッピングエディター – C を開くを参照してください。

モデル ECoderMapAPI を開きます。

simulinkModel = "ECoderMapAPI";
open_system(simulinkModel);

モデルのコードマッピングオブジェクトを取得します。

codeMapObj = coder.mapping.api.get(simulinkModel);

周期関数と初期化関数の FunctionName プロパティを取得します。

periodicFcnName = getFunction(codeMapObj,"Periodic:D1","FunctionName")

periodicFcnName = 
'myPeriodicFcn'

InitFcnName = getFunction(codeMapObj,"Initialize","FunctionName")

InitFcnName = 
'myInitFcn'

モデルからコードを生成します。

evalc("slbuild(simulinkModel)");

エントリポイント関数はモデルヘッダーファイルで宣言されます。ヘッダーファイル名を変数 model_h_file に格納します。

model_h_file = fullfile(simulinkModel+"_ert_rtw",simulinkModel+".h")

model_h_file = 
"ECoderMapAPI_ert_rtw/ECoderMapAPI.h"

以下に、ヘッダーファイル内のエントリポイント関数の宣言を示します。

/* Model entry point functions */
extern void myInitFcn(void);
extern void myPeriodicFcn(void);

関数名は periodicFcnName および InitFcnName に格納されている名前です。

ヘッダーファイルを開くには、MATLAB $^{®}$ コマンドウィンドウに次のコマンドを入力します。

edit(model_h_file)

周期関数の名前を変更します。

if(startsWith(periodicFcnName,"my"))
  setFunction(codeMapObj,"Periodic:D1",FunctionName="yourPeriodicFcn");
else
  setFunction(codeMapObj,"Periodic:D1",FunctionName="myPeriodicFcn");
end
if(startsWith(InitFcnName,"my"))
  setFunction(codeMapObj,"Initialize",FunctionName="yourInitFcn");
else
  setFunction(codeMapObj,"Initialize",FunctionName="myInitFcn");
end

新しいエントリポイント関数名を使用して、モデルからコードを再度生成します。

evalc("slbuild(simulinkModel)");

以下に、ヘッダーファイル内のエントリポイント関数の更新された宣言を示します。

/* Model entry point functions */
extern void yourInitFcn(void);
extern void yourPeriodicFcn(void);

関数名が更新されています。

入力引数

すべて折りたたむ

`coderMapObj` — コードマッピングオブジェクト
`CodeMapping` オブジェクト

関数 coder.mapping.api.get の呼び出しによって返されるコードマッピングオブジェクト (モデルコードマッピング)。

例: myCM

`modelFunc` — モデル関数
`"Initialize"` | `"Periodic"` | `"PartitionUpdate"` | `"Terminate"` | ...

コードマッピングプロパティ値を返す対象となるモデル関数。下表の値のいずれかとして指定します。モデルコンフィギュレーションパラメーター [1 つの出力/更新関数] がオフの場合、更新されたバージョンの分割関数、周期的なマルチタスク関数、または周期的なシングルタスク関数を指定できます。モデル分割の詳細については、分割の作成を参照してください。

値	モデル関数のタイプ
`"Initialize"`	初期化関数
`"Periodic"`	周期的なシングルタスク関数
`"PeriodicUpdate"`	周期的なシングルタスク更新関数
`"Terminate"`	終了関数
`"Periodic:slIdentifier"`。ここで、`slIdentifier` はマルチタスクモデルの周期レートまたは連続レートに対するサンプル時間の周期に対応する注釈 (`D1` など) です。	周期的なマルチタスク関数
`"PeriodicUpdate:slIdentifier"`。ここで、`slIdentifier` はマルチタスクモデルの周期レートまたは連続レートに対するサンプル時間の周期に対応する注釈 (`D1` など) です。	周期的なマルチタスク更新関数
`"Reset:slIdentifier"`。ここで `slIdentifier` はモデル内のリセット関数の名前です。	リセット関数
`"SimulinkFunction:slIdentifier"`。ここで `slIdentifier` はモデル内の Simulink 関数の名前です。	Simulink^® 関数

例: "Periodic:D1"

`funcProperty` — 返すコードマッピングプロパティ値
`FunctionCustomizationTemplate` | `MemorySection` | `FunctionName` | `Arguments` | `TimerService`

返されるコードマッピングプロパティ値。次の表に示されているいずれかのプロパティ名を指定します。

返す情報	プロパティ名
指定された関数に対する関数カスタマイズテンプレート設定	`FunctionCustomizationTemplate`
指定された関数に関連付けられているメモリセクション	`MemorySection`
生成されたコードの関数に対して使用する名前	`FunctionName`
周期的なシングルタスク関数と Simulink 関数の引数について、生成されたコードに表示される際の名前、型修飾子、および順序を示す string	`Arguments`
Embedded Coder ディクショナリで定義されているタイマーサービスの名前	`TimerService`