coder.mapping.api.get

モデルのコードマッピングの取得

構文

coderMapObj = coder.mapping.api.get(simulinkModel)

coderMapObj = coder.mapping.api.get(simulinkModel,codeMappingType)

coderDataDictObj = coder.mapping.api.get(coderDictionary)

説明

coderMapObj = coder.mapping.api.get(simulinkModel) は指定されたモデルに対してアクティブなコードマッピングを coderMapObj オブジェクトとして返します。コードマッピングはモデルデータ要素と関数を C または C++ コード生成の構成に関連付けます。モデルに複数のコードマッピングがある場合、アクティブなコードマッピングはアクティブなシステムターゲットファイルに関連付けられたマッピングです。

コードマッピングが存在しない場合、エラーが生成されます。モデルの Coder アプリを開くと、Simulink^® はコードマッピングオブジェクトを作成します。モデルの Coder アプリを開いていない場合は、関数 coder.mapping.utils.create を呼び出してコードマッピングオブジェクトを作成できます。

例

coderMapObj = coder.mapping.api.get(simulinkModel,codeMappingType) は指定されたコードマッピングタイプに対応するモデルのコードマッピングを coderMapObj オブジェクトとして返します。

例

coderDataDictObj = coder.mapping.api.get(coderDictionary) は、coderDictionary で指定された共有ディクショナリ内のデータと関数の既定値を取得および設定するために使用できるオブジェクト coderDataDictObj を返します。

メモ

オブジェクト coderMapObj を使用してディクショナリに加えた変更を保存するには、同じディクショナリに対して一般ディクショナリオブジェクト Simulink.data.Dictionary を作成して使用します。
この関数の構文は、データインターフェイスディクショナリでのみサポートされています。

例

すべて折りたたむ

Simulink $^{®}$ モデルのコードマッピングのプログラムによる作成と使用

ライブスクリプトを開く

プログラムインターフェイスを使用して、Simulink モデルのコードマッピングオブジェクトを作成および使用します。

モデル NoCoderMapping を読み込みます。

simulinkModel = "NoCoderMapping";
load_system(simulinkModel);

try-catch ブロックを使用して、モデル用にコードマッピングオブジェクトが存在するかどうかを判別します。try ブロック内で、関数 coder.mapping.api.get を使用して既存のオブジェクトの取得を試みます。catch ブロック内で、関数 coder.mapping.utils.create を使用して新しいコードマッピングオブジェクトを作成します。コードマッピングオブジェクトを変数 codeMapObj に保存します。

モデルに既存のコードマッピングオブジェクトがあったかどうかを示す出力メッセージを追加します。

try
  codeMapObj = coder.mapping.api.get(simulinkModel);
          fprintf("" + ...
            " ========================================================\n" + ...
            " The model already had code mappings.\n" + ...
            " ========================================================\n");
catch
          fprintf("" + ...
            " ==========================================\n" + ...
            " The model does not have code mappings.\n" + ...
            " Creating new code mappings for the model.\n" + ...
            " ==========================================\n");
  codeMapObj = coder.mapping.utils.create(simulinkModel);
end

 ==========================================
 The model does not have code mappings.
 Creating new code mappings for the model.
 ==========================================

モデルの入力端子 inport_1 のストレージクラスを取得します。

getInport(codeMapObj,"inport_1","StorageClass")

ans = 
'Auto'

入力端子 inport_1 のストレージクラスを ExportedGlobal に設定します。

setInport(codeMapObj,"inport_1",StorageClass="ExportedGlobal")

同じ try-catch ブロックを使用して、関数 coder.mapping.api.get でモデルの既存のコードマッピングをどのように取得できるようになったかを確認します。

try
  codeMapObj = coder.mapping.api.get(simulinkModel);
          fprintf("" + ...
            " ========================================================\n" + ...
            " The model already had code mappings.\n" + ...
            " ========================================================\n");
catch
          fprintf("" + ...
            " ==========================================\n" + ...
            " The model does not have code mappings.\n" + ...
            " Creating new code mappings for the model.\n" + ...
            " ==========================================\n");
  codeMapObj = coder.mapping.utils.create(simulinkModel);
end

 ========================================================
 The model already had code mappings.
 ========================================================

モデルの入力端子 inport_1 のストレージクラスを取得します。これは、以前に設定したストレージクラスであることに注意してください。

getInport(codeMapObj,"inport_1","StorageClass")

ans = 
'ExportedGlobal'

モデルを保存せずに閉じます。

close_system(simulinkModel,false)

コーダーディクショナリでのコードマッピングオブジェクトのプログラムによる取得と使用

ライブスクリプトを開く

"Embedded Coder $^{®}$ ディクショナリ" を使用してコードマッピングオブジェクトをプログラムによって取得して使用します。

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

モデルとディクショナリのファイル名を保存してから、モデル ECoderMapAPI を開きます。

simulinkModel = "ECoderMapAPI";
dict_name = "ECoderDataDict.sldd";
load_system(simulinkModel);

共有ディクショナリのコードマッピングを使用するには、共有ディクショナリを使用するようにモデルを構成します。

set_param(simulinkModel,EmbeddedCoderDictionary="ECoderDataDict.sldd");

Get を使用してモデルのコードマッピングオブジェクトを取得し、そのオブジェクトを使用して以下を行います。

モデルのすべてのルートレベルの端子のストレージクラスとして Model default を指定する。
ルートレベルの端子の既定のストレージクラスとして Dictionary default を指定する。

modelCodeMapObj = coder.mapping.api.get(simulinkModel);
setInport(modelCodeMapObj,find(modelCodeMapObj,"Inports"),StorageClass="Model default")
setOutport(modelCodeMapObj,find(modelCodeMapObj,"Outports"),StorageClass="Model default")
setDataDefault(modelCodeMapObj,"Inports",StorageClass="Dictionary default")
setDataDefault(modelCodeMapObj,"Outports",StorageClass="Dictionary default")

コーダーディクショナリには、モデルのコードマッピングで使用できる定義などが含まれます。コードマッピング API を使用すると、共有コーダーディクショナリ内のデータおよび関数の既定の設定を取得および制御できます。

ディクショナリ ECoderDataDict.sldd のコードマッピングオブジェクトを取得します。このオブジェクトを使用して、ディクショナリのデータおよび関数の既定の設定を表示および制御します。

coderMapDictObj = coder.mapping.api.get(dict_name);

同じ共有ディクショナリの一般ディクショナリオブジェクトを取得します。このオブジェクトを使用して、コードマッピングに関係のない、ディクショナリの一般的な要素を制御します。この例では、ディクショナリのコードマッピングオブジェクトを使用してディクショナリに変更を加えた後にディクショナリを保存するために、この一般ディクショナリオブジェクトが必要になります。

dictObj = Simulink.data.dictionary.open(dict_name);

ディクショナリのコードマッピングオブジェクトを使用して、入力端子の既定のストレージクラスを Localizable に設定し、出力端子の既定のストレージクラスを Volatile に設定します。

setDataDefault(coderMapDictObj,"Inports",StorageClass="Localizable");
setDataDefault(coderMapDictObj,"Outports",StorageClass="Volatile");

既定のストレージクラスが意図したとおりに設定されていることを確認します。

getDataDefault(coderMapDictObj,"Inports","StorageClass")

ans = 
'Localizable'

getDataDefault(coderMapDictObj,"Outports","StorageClass")

ans = 
'Volatile'

変数 Localizable と変数 Volatile は、生成されたモデルヘッダーファイルの別個のセクションで宣言されます。ヘッダーファイル名を変数 model_h_file に格納します。

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

model_h_file = 
"ECoderMapAPI_ert_rtw/ECoderMapAPI.h"

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

evalc("slbuild(simulinkModel)");

以下に、ヘッダーファイル内のルートレベルの入力端子および出力端子の宣言を示します。

/* Declaration for custom storage class: Localizable */
extern real_T in_port_1;               /* '<Root>/in_port_1' */
extern real_T in_port_2;               /* '<Root>/in_port_2' */
extern real_T in_port_3;               /* '<Root>/in_port_3' */
extern real_T in_port_4;               /* '<Root>/in_port_4' */

/* Declaration for custom storage class: Volatile */
extern volatile real_T out_port_1;     /* '<Root>/out_port_1' */
extern volatile real_T out_port_2;     /* '<Root>/out_port_2' */
extern volatile real_T out_port_3;     /* '<Root>/out_port_3' */
extern volatile real_T out_port_4;     /* '<Root>/out_port_4' */

端子は、ディクショナリのデータの既定の設定で指定されたストレージクラスです。

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

edit(model_h_file)

ディクショナリのコードマッピングオブジェクトを指定して関数 setDataDefault を使用して、ディクショナリ内の入力端子と出力端子の既定のストレージクラスを切り替えます。

setDataDefault(coderMapDictObj,"Inports",StorageClass="Volatile");
setDataDefault(coderMapDictObj,"Outports",StorageClass="Localizable");

既定のストレージクラスが意図したとおりに設定されていることを確認します。

getDataDefault(coderMapDictObj,"Inports","StorageClass")

ans = 
'Volatile'

getDataDefault(coderMapDictObj,"Outports","StorageClass")

ans = 
'Localizable'

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

evalc("slbuild(simulinkModel)");

ヘッダーファイル内の入力端子と出力端子の宣言が、構成したストレージクラスで更新されました。

/* Declaration for custom storage class: Localizable */
extern real_T out_port_1;              /* '<Root>/out_port_1' */
extern real_T out_port_2;              /* '<Root>/out_port_2' */
extern real_T out_port_3;              /* '<Root>/out_port_3' */
extern real_T out_port_4;              /* '<Root>/out_port_4' */

/* Declaration for custom storage class: Volatile */
extern volatile real_T in_port_1;      /* '<Root>/in_port_1' */
extern volatile real_T in_port_2;      /* '<Root>/in_port_2' */
extern volatile real_T in_port_3;      /* '<Root>/in_port_3' */
extern volatile real_T in_port_4;      /* '<Root>/in_port_4' */

一般ディクショナリオブジェクト dictObj を使用して、ディクショナリに加えた変更を保存し、ディクショナリを閉じます。

saveChanges(dictObj);
close(dictObj);

Simulink $^{®}$ モデルでの複数のコードマッピングタイプのプログラムによる取得と使用

ライブスクリプトを開く

プログラムインターフェイスを使用して、Simulink モデルのさまざまなタイプのコードマッピングオブジェクトを取得して使用します。

モデル CoderMapAPI を読み込みます。

codeMapModel = "CoderMapAPI";
load_system(codeMapModel);

関数 coder.mapping.api.get を使用して、このモデルの Simulink $^{®}$ Coder™ および Embedded Coder $^{®}$ マッピングオブジェクトを取得して保存します。

simCodeMapObj = coder.mapping.api.get(codeMapModel,"SimulinkCoderC");
eCodeMapObj = coder.mapping.api.get(codeMapModel,"EmbeddedCoderC");

すべてのルートレベルの入力端子名を保存します。

in_port_names = "in_port_"+(1:4)'

in_port_names = 4×1 string
    "in_port_1"
    "in_port_2"
    "in_port_3"
    "in_port_4"

コードマッピングオブジェクトごとに、入力端子のストレージクラスを設定するインライン関数を定義します。関数 arrayfun を使用して、Simulink コードマッピングオブジェクトのすべてのルートレベルの入力端子のストレージクラスを ImportedExtern に設定し、Embedded Coder マッピングオブジェクトのルートレベルの入力端子のストレージクラスを ImportedExternPointer に設定します。

configSimCoderPortStoreClassFcn = @(port_name) setInport(simCodeMapObj,port_name,StorageClass="ImportedExtern");
configECoderPortStoreClassFcn = @(port_name) setInport(eCodeMapObj,port_name,StorageClass="ImportedExternPointer");
arrayfun(configSimCoderPortStoreClassFcn,in_port_names);
arrayfun(configECoderPortStoreClassFcn,in_port_names);

コードマッピングオブジェクトごとに、入力端子のストレージクラスを表示するインライン関数を定義します。

dispSimCoderPortStoreClassFcn = @(port_name) disp(getInport(simCodeMapObj,port_name,"StorageClass"));
dispECoderPortStoreClassFcn = @(port_name) disp(getInport(eCodeMapObj,port_name,"StorageClass"));

各コードマッピングオブジェクトのルートレベルの入力端子のストレージクラスを表示します。

arrayfun(dispSimCoderPortStoreClassFcn,in_port_names);

ImportedExtern
ImportedExtern
ImportedExtern
ImportedExtern

arrayfun(dispECoderPortStoreClassFcn,in_port_names);

ImportedExternPointer
ImportedExternPointer
ImportedExternPointer
ImportedExternPointer

ImportedExtern および ImportedExternPointer ストレージクラスをもつルートレベルの入力端子は、モデルの生成されたプライベートヘッダーファイル内の別個のセクションで宣言されます。両方のヘッダーファイルでこれらのセクションを確認できるように、2 つのシステムターゲットファイルのヘッダーファイル名を保存します。

priv_h_simcoder_file = fullfile(codeMapModel+"_grt_rtw",codeMapModel+"_private.h")

priv_h_simcoder_file = 
"CoderMapAPI_grt_rtw/CoderMapAPI_private.h"

priv_h_ecoder_file = fullfile(codeMapModel+"_ert_rtw",codeMapModel+"_private.h")

priv_h_ecoder_file = 
"CoderMapAPI_ert_rtw/CoderMapAPI_private.h"

モデルのターゲットファイルを grt.tlc に設定し、モデルからコードを生成します。

set_param(codeMapModel,SystemTargetFile="grt.tlc")
evalc("slbuild(codeMapModel)");

以下に、grt.tlc ヘッダーファイル priv_h_simcoder_file 内のルートレベルの入力端子の宣言を示します。

/* Imported (extern) block signals */
extern real_T in_port_1;               /* '<Root>/in_port_1' */
extern real_T in_port_2;               /* '<Root>/in_port_2' */
extern real_T in_port_3;               /* '<Root>/in_port_3' */
extern real_T in_port_4;               /* '<Root>/in_port_4' */

ルートレベルの入力端子は、ImportedExtern セクションで宣言されます。

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

edit(priv_h_simcoder_file)

次に、モデルのターゲットファイルを ert.tlc に設定し、モデルからコードを生成します。

set_param(codeMapModel,SystemTargetFile="ert.tlc")
evalc("slbuild(codeMapModel)");

以下に、ert.tlc ヘッダーファイル priv_h_ecoder_file 内のルートレベルの入力端子の宣言を示します。

/* Imported (extern) pointer block signals */
extern real_T *in_port_1;              /* '<Root>/in_port_1' */
extern real_T *in_port_2;              /* '<Root>/in_port_2' */
extern real_T *in_port_3;              /* '<Root>/in_port_3' */
extern real_T *in_port_4;              /* '<Root>/in_port_4' */

このヘッダーファイルのルートレベルの入力端子は、ImportedExternPointer セクションで宣言されます。

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

edit(priv_h_ecoder_file)

入力引数

すべて折りたたむ

`simulinkModel` — Simulink モデル
ハンドル | 文字ベクトル | string スカラー

コードマッピングオブジェクトを返す対象の Simulink モデル。ハンドル、またはモデル名 (.slx ファイル拡張子なし) あるいはモデルファイルの相対パスまたは絶対パス (.slx ファイル拡張子を含む) を含む文字ベクトルまたは string スカラーとして指定します。

メモ

モデルが (たとえば、load_system を使用して) 読み込まれていなければなりません。

例: "configModel"

データ型: char | string | handle

`coderDictionary` — コーダーデータインターフェイスディクショナリ
文字ベクトル | string スカラー | `Simulink.data.Dictionary`

コードマッピングオブジェクトを返す対象のデータインターフェイスディクショナリ。Simulink.data.Dictionary オブジェクト、またはディクショナリファイルの相対パスまたは絶対パス (.sldd ファイル拡張子を含む) を含む文字ベクトルまたは string スカラーとして指定します。

例: "exCodeDefs.sldd"

データ型: char | string | Simulink.data.Dictionary

`codeMappingType` — コードマッピングのタイプ
`"SimulinkCoderC"` | `"EmbeddedCoderC"` | `"EmbeddedCoderCPP"`

指定されたモデルまたはディクショナリに対して返すコードマッピングのタイプ。表内の値のいずれかとして指定します。コードマッピングを使用すると、モデルをプラットフォームに適したコード生成構成に関連付けることができます。指定されたマッピングタイプが存在しない場合は、エラーが生成されます。

コードマッピングタイプ	コード生成の構成	詳細
`"SimulinkCoderC"`	C 言語ラピッドプロトタイピングプラットフォーム	Simulink Coder™ および C 言語
`"EmbeddedCoderC"`	C 言語生成プラットフォーム	Embedded Coder^® および C 言語
`"EmbeddedCoderCPP"`	C++ 言語生成プラットフォーム	Embedded Coder および C++ 言語

出力引数

すべて折りたたむ

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

モデルのコードマッピングオブジェクト。CodeMapping オブジェクトまたは CodeMappingCPP として返されます。

出力	入力オブジェクト	コードマッピングタイプ
`coder.mapping.api.CodeMapping`	Simulink モデル	`"SimulinkCoderC"` または `"EmbeddedCoderC"`
`coder.mapping.api.CodeMappingCPP`	Simulink モデル	`"EmbeddedCoderCPP"`

`coderDataDictObj` — Embedded Coder データディクショナリ
`CoderDictionary` オブジェクト

Embedded Coder データディクショナリ。coder.mapping.api.CoderDictionary オブジェクトとして返されます。

バージョン履歴

R2020b で導入

参考

coder.mapping.api.CodeMapping | coder.mapping.utils.create | coder.mapping.api.CoderDictionary | coder.mapping.api.CodeMappingCPP

coder.mapping.api.get

構文

説明

例

Simulink® モデルのコード マッピングのプログラムによる作成と使用

コーダー ディクショナリでのコード マッピング オブジェクトのプログラムによる取得と使用

Simulink® モデルでの複数のコード マッピング タイプのプログラムによる取得と使用

入力引数

simulinkModel — Simulink モデル ハンドル | 文字ベクトル | string スカラー

coderDictionary — コーダー データ インターフェイス ディクショナリ 文字ベクトル | string スカラー | Simulink.data.Dictionary

codeMappingType — コード マッピングのタイプ "SimulinkCoderC" | "EmbeddedCoderC" | "EmbeddedCoderCPP"

出力引数

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

coderDataDictObj — Embedded Coder データ ディクショナリ CoderDictionary オブジェクト

バージョン履歴

参考

トピック

Simulink $^{®}$ モデルのコードマッピングのプログラムによる作成と使用

コーダーディクショナリでのコードマッピングオブジェクトのプログラムによる取得と使用

Simulink $^{®}$ モデルでの複数のコードマッピングタイプのプログラムによる取得と使用

`simulinkModel` — Simulink モデル
ハンドル | 文字ベクトル | string スカラー

`coderDictionary` — コーダーデータインターフェイスディクショナリ
文字ベクトル | string スカラー | `Simulink.data.Dictionary`

`codeMappingType` — コードマッピングのタイプ
`"SimulinkCoderC"` | `"EmbeddedCoderC"` | `"EmbeddedCoderCPP"`

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

`coderDataDictObj` — Embedded Coder データディクショナリ
`CoderDictionary` オブジェクト