Stateflow チャートでのカスタムコードの再利用

C または C++ で記述されたカスタムコードを、Simulink^® モデルの Stateflow^® チャートと統合できます。カスタムコードと Stateflow チャートの間でデータと関数を共有することにより、Stateflow の機能を拡張し、既存のコードを活用できます。

Stateflow チャートへのカスタム C コードの統合

この例では次を使用します。

モデルを開く

この例では、カスタム C コードを使用して、モデル内のチャートでアクセスできる定数、変数、および関数を定義する方法を説明します。チャートへのカスタム C++ コードの統合の詳細については、Stateflow チャート内のカスタム C++ コードへのアクセスを参照してください。

次の例では、Stateflow チャートが custom_function というカスタムコード関数を呼び出します。この関数は、チャート入力 signal とローカルデータ threshold を読み取り、それらの値を比較してから、HIGH、MEDIUM、および LOW という 3 つのカスタムグローバル定数のいずれかを返します。このチャートは、関数の値を使用して、custom_var というカスタム変数の値をインクリメントまたはデクリメントした後に新しいステートに遷移するかどうかを決定します。

このチャートがアクセスするカスタムコードを表示するには、[コンフィギュレーションパラメーター] ダイアログボックスを開き、[シミュレーションターゲット] ペインで [コード情報] タブを選択します。

[インクルードヘッダー] パラメーターには、ヘッダーファイル sf_custom_header.h を指定する #include ステートメントが含まれています。このファイルには、3 つの静的なグローバル定数の定義と、変数 custom_var および関数 custom_function の宣言が含まれています。
[ソースファイル] パラメーターは、ソースファイル sf_custom_source.c を指定します。このファイルは custom_var の初期値をゼロに設定し、関数 custom_function を定義します。

いずれのファイルも、モデルと同じフォルダーにあります。別のフォルダーにあるカスタムコードファイルにアクセスするには、相対パス名を使用します。詳細については、カスタムコードへの相対パスの指定を参照してください。

このモデルをシミュレートすると、Stateflow はソースファイルとチャートを単一の S-Function MEX ファイルにコンパイルします。カスタム定義は生成されたマシンのヘッダーファイル (sf_custom_header.h) の先頭に配置されるため、シミュレーション中にモデル内の各チャートはカスタムコードにアクセスできます。

カスタムコードの構成

シミュレーション用のカスタムコード設定の指定

C のソース、ヘッダー、およびライブラリファイルを指定する例は、次のフォルダー構造に基づいています。

The MATLAB file browser shows three folders: "src", "includes" and "lib". "src" contains three C files. "includes" contains two header files and a "utilities" folder with one header file. "lib" contains a DLL library and a "additional libraries" folder with a DLL library.

シミュレーション中にモデルがカスタムコードにアクセスするように構成するには、次の手順に従います。

[コンフィギュレーションパラメーター] ダイアログボックスを開きます。この方法の詳細については、ダイアログボックスを使用したコンフィギュレーションパラメーターの設定 (Simulink)を参照してください。
[シミュレーションターゲット] ペインの [コード情報] タブで、次のパラメーターを指定します。
- インクルードヘッダー — 生成される model.h ヘッダーファイルの冒頭にインクルードするコード (生成コード内のカスタム関数やデータを宣言する) を入力します。このコード行は生成されるすべてのソースコードファイルの冒頭に配置され、すべての生成コードから認識されます。たとえば、このパラメーターを使用して、#include ステートメントと #define ステートメントを入力できます。カスタムヘッダーファイルをインクルードする場合は、ファイル名を二重引用符で囲む必要があります。詳細については、ヘッダーを含める (Simulink)を参照してください。
  メモ
  このパラメーターで指定するコードには、extern int x や extern void myfun(void) など、変数や関数の extern 宣言をインクルードすることが可能です。ただし、int x や void myfun(void) などのグローバル変数や関数定義は、その定義が生成コードのソースファイルに複数回出現するため、リンクエラーを引き起こします。
- インクルードディレクトリ — コンフィギュレーションパラメーターに直接的に、またはコンパイルされるターゲットに間接的にインクルードするカスタムヘッダー、ソース、およびライブラリの各ファイルを含むフォルダーパスのリストを入力します。エントリを区切るには、改行、スペース、またはセミコロンを使用できます。詳細については、インクルードディレクトリ (Simulink)を参照してください。
- ソースファイル — コンパイルしてターゲットにリンクするソースファイルのリストを、改行、スペース、またはセミコロンで区切って入力します。詳細については、ソースファイル (Simulink)を参照してください。
- ライブラリ — ターゲットにリンクするカスタムオブジェクトコードを含むスタティックライブラリのリストを、改行、スペース、またはセミコロンで区切って入力します。詳細については、ライブラリ (Simulink)を参照してください。
- 定義 — 生成コードに追加するプリプロセッサマクロ定義のリストをスペースで区切って入力します。詳細については、定義 (Simulink)を参照してください。
- コンパイラフラグ — カスタムコードのコンパイル時にコンパイラのコマンドラインに追加する追加のコンパイラフラグを入力します。詳細については、コンパイラフラグ (Simulink)を参照してください。
- リンカーフラグ — カスタムコードのリンク時にリンカーのコマンドラインに追加する追加のリンカーフラグを入力します。詳細については、リンカーフラグ (Simulink)を参照してください。
[詳細設定パラメーター] の [カスタムコードのインポート] (Simulink) がオンになっていることを確認します。このパラメーターは既定で有効になっています。

コマンドライン API を使用したシミュレーションオプションの設定の詳細については、プログラムによるコンフィギュレーションパラメーターの設定を参照してください。

コード生成用のカスタムコード設定の指定

モデルがコード生成用のカスタムコードにアクセスするように構成するには、[コンフィギュレーションパラメーター] ダイアログボックスの [コード生成] 、 [カスタムコード] ペインを使用します。コード生成時に、シミュレーションに使用したものと同じカスタムコード設定、または固有のカスタムコード設定を使用できます。

シミュレーションに使用したものと同じカスタムコード設定を使用するには、[シミュレーションターゲットと同じカスタムコードの設定を使用] をオンにします。シミュレーション用のカスタムコード設定の指定の説明に従って、[シミュレーションターゲット] ペインでカスタムコード設定を指定します。
固有のカスタムコード設定を使用するには、[シミュレーションターゲットと同じカスタムコードの設定を使用] をオフにします。[コード情報] タブで、コード生成用のカスタムコード設定を指定します。このタブのパラメーターの説明については、シミュレーション用のカスタムコード設定の指定を参照してください。

The Code Generation Custom Code pane of the Configuration Parameters dialog box shows the same custom code settings specified in the Simulation Target pane.

詳細については、シミュレーションターゲットと同じカスタムコードの設定を使用 (Simulink Coder)およびモデルコンフィギュレーションパラメーターを使用した外部コードの統合 (Simulink Coder)を参照してください。

ステートと遷移におけるカスタムコード関数の呼び出し

カスタムコード関数は、任意のステートまたは遷移のアクション、または他の関数から呼び出すことができます。

カスタムコード関数を呼び出すには、ヘッダーファイルの関数の宣言で指定したシグネチャを使用します。関数シグネチャの仮引数のそれぞれに、実際の引数の値をインクルードします。

return_val = function_name(arg1,arg2,...)

カスタムコードの構成

モデルにライブラリチャートが含まれる場合は、チャートをモデルに提供する各ライブラリモデルのカスタムコード設定を構成します。詳細については、ライブラリモデル内のカスタムコードの構成を参照してください。
MATLAB^® をアクション言語として使用するチャートでは、カスタムコードで #define ステートメントはサポートされません。チャートとカスタムコードの間で定数を共有するには、マクロではなく、静的なグローバル定数を使用します。
カスタムコードと Stateflow チャートの間では、固定小数点データは共有しないでください。

カスタムコードへの相対パスの指定

モデルの更新時、またはシミュレーションの開始時に、モデルは以下のフォルダーでカスタムコードファイルを検索します。

現在のフォルダー
モデルフォルダー (このフォルダーが現在のフォルダーと異なる場合)
指定するフォルダーのカスタムリスト
ツールボックスフォルダーを除く、MATLAB 検索パス上にあるすべてのフォルダー

これらのフォルダーへの相対パスを使用して、カスタムコードの場所を指定できます。たとえば、前の例で、カスタムコードのソースファイルとヘッダーファイルをモデルフォルダーのサブフォルダー CustomCode/SourceFiles および CustomCode/HeaderFiles に保存したとします。これらのファイルにアクセスするには、[インクルードディレクトリ] パラメーターを使用してサブフォルダーの相対パスを指定します。

The Simulation Target pane of the Configuration Parameters dialog box shows the relative paths to two subfolders.

あるいは、相対パス名を使用して、ヘッダーファイルとソースファイルを個別に指定できます。

[インクルードヘッダー] に次のパス名を入力します。

#include "./CustomCode/HeaderFiles/sf_custom_code_constants_vars_fcns_hdr.h"

[ソースファイル] に次のパス名を入力します。

./CustomCode/HeaderFiles/sf_custom_code_constants_vars_fcns_src.c

相対パスの構文に関するガイドライン

カスタムコードの相対パスを構成するときには、以下の構文のガイドラインに従います。

相対パスの開始位置を示すには、単一のピリオド (.) を使用する。
使用しているプラットフォームにかかわらず、ファイル区切りとしてスラッシュ (/) またはバックスラッシュ (\) を使用する。
パスに空白やハイフン (-) などの非標準パス文字が含まれる場合は、パスを二重引用符 ("...") で囲む。
式を MATLAB ワークスペースで評価するには、その式をドル記号 ( $...$ ) で囲む。この例では、CustomCodeFolder を MATLAB ワークスペースで "module1" として定義した変数と仮定します。パス名 .\work\source\$CustomCodeFolder$ を使用してカスタムコードファイルを指定すると、モデルはフォルダー .\work\source\module1 でカスタムコードファイルを検索します。