C Function
外部 C/C++ コードの Simulink モデルからの統合と呼び出し
ライブラリ:
Simulink /
User-Defined Functions
説明
C Function ブロックは外部 C/C++ コードを Simulink® モデルから統合し、呼び出します。このブロックを使用して、データの前処理または後処理を行うことで、外部コードを定義し、コードの統合をカスタマイズします。また、カスタマイズされたコードをシミュレーションと C コードの生成に指定できます。コードで定義されている関数を条件付きで呼び出すことも、1 つのブロックで複数の関数を呼び出すこともできます。このブロックを使用して、永続データを初期化し、外部関数に渡すことができます。
C Function ブロックは永続データの初期化とブロックのダイアログ ボックスからの外部関数の呼び出しをサポートします。永続データには、カスタム コードで定義されている C++ クラスのオブジェクトを含めることができます。Interface with C++ Classes Using C Function Blockを参照してください。このブロックは、永続データの初期化と終了のみをサポートします。ブロックは、シミュレーション中のデータの更新をサポートしません。連続状態をもつ動的システムをモデル化するには、S-Function ブロックを使用します。S-Function の詳細については、S-Function とはを参照してください。
メモ
Simulink へのカスタム C コード統合でサポートされる C 言語の標準バージョンは C99 です。
カスタム コードの指定
R2024a 以降では、このブロックに、ブロックのカスタム C/C++ コードを指定するためのさまざまなオプションが用意されています。
ブロック内でカスタム コードをローカルに指定できるため、単一のブロックに完全に含まれるコード コンポーネントを統合できます。たとえば、C/C++ コードを使用して定義されたカスタム フィルターをモデルに統合するには、このオプションを使用してカスタム コードをローカルに指定します。これにより、ブロックは指定されたフィルターと同様に動作します。
R2026a 以降のバージョンの場合:
ローカルに指定されたカスタム コードをもつ C Function ブロックをデバッグする場合、そのブロックを含むモデルのシミュレーション モードに関係なく、ローカル カスタム コードは MATLAB® の外部にある別のプロセスで実行されます。これは、"アウトプロセス" シミュレーションと呼ばれます。カスタム コードが別の実行可能ファイル内に組み込まれるため、このモードはより安全です。結果として、カスタム コードで問題が生じても MATLAB がクラッシュすることはありません。カスタム C/C++ コードのデバッグの詳細については、Debug Custom C/C++ Codeを参照してください。
ローカルに指定されたカスタム コードをもつ C Function ブロックを含むモデルをシミュレーションすると、次のようになります。
ノーマル モードでは、ローカル カスタム コードはアウトプロセス シミュレーションでシミュレーションを実行します。
アクセラレータ モードでは、ローカル カスタム コードはダイナミック ライブラリに組み込まれ、MATLAB と同じプロセス内でシミュレーションを実行します。これは、"インプロセス" シミュレーションと呼ばれます。このモードはアウトプロセス シミュレーションより高速ですが、カスタム コードで生じた問題により MATLAB がクラッシュする可能性があります。
以前は、C Function ブロックを含むモデルのシミュレーション モードに関係なく、ローカルに指定されたカスタム コードのデバッグとシミュレーションはどちらもアウトプロセス シミュレーションで実行されました。
カスタム コードは、モデル内の他のブロックまたは複数のモデルで共有できます。複数のモデルでカスタム コードを共有するには、Simulink ライブラリ モデルの [コンフィギュレーション パラメーター] ダイアログ ボックスでカスタム コードを定義する必要があります。その後、ライブラリ内のブロックでコードを使用し、他のモデルでそのライブラリからそのブロックを取得します。
詳細については、[カスタム コード設定を構成します] を参照してください。
Simulink でのランタイム エラーと警告のレポート
C Function ブロックで指定するカスタム C コードで、関数 slError と slWarning を使用して、ランタイム エラーと警告をそれぞれレポートします。エラーが発生するとシミュレーションが終了します。シミュレーションを続行する前にエラーを解決する必要があります。警告はコードに潜在的な問題があることを示しますが、シミュレーションは終了しません。
関数 slError と slWarning はどちらも、C と似た各種データ型書式指定子 (たとえば、整数の場合は %d 、浮動小数点の場合は %f ) をサポートしています。
次に例を示します。
slError("Error message");slError("Input %f should be non-negative", x);slWarning("Warning message");slWarning("Input %d should be non-zero", y);
次のコードがシミュレーションの開始時に実行されます。関数 slError を使用して、シミュレーションの開始時にデータ ストアの初期化に失敗した場合にエラー メッセージを出します。
カスタム コードで行優先および列優先の配列レイアウトを指定
slSetRowMajor 関数と slSetColumnMajor 関数を使用して、それぞれ行優先と列優先の配列レイアウトを指定します。これらの関数は、[コンフィギュレーション パラメーター] ダイアログ ボックスの [シミュレーション ターゲット] ペインで指定します。C Function ブロックのダイアログ ボックスから [コンフィギュレーション パラメーター] ダイアログ ボックスにアクセスするには、[カスタム コード設定を構成します]
パラメーターを [コンフィギュレーション パラメーターのカスタム コードを使用] に設定します。
行優先レイアウトでは、行列の行要素がメモリに連続して格納されます。同様に、列優先レイアウトでは、行列の列要素がメモリに連続して格納されます。詳細については、行優先および列優先の配列レイアウト (MATLAB Coder)を参照してください。
[カスタム コード設定を構成します] パラメーターを [コンフィギュレーション パラメーターのカスタム コードを使用] に設定すると、ブロックでは、シミュレーションとコード生成のどちらにおいても行優先と列優先の両方の構成を使用できます。
[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定すると、ブロックでは、シミュレーションに行優先、コード生成に列優先を使用します。
関数プロトタイプ:
void slSetRowMajor(const char* functionName)void slSetColumnMajor(const char* functionName)
functionName は文字列リテラルでなければならず、完全修飾されている必要があります。
たとえば、以下のコードについて考えます。
namespace NS1 { class ACLASS{ public: void foo_row(); }; namespace NS2{ void foo_col(double*, double*); } }
完全修飾関数名については、次のとおりです。
関数が名前空間内にある場合は、入れ子にされたすべての名前空間が関数名 string に含まれている必要があります。上記のコードに基づくと、列優先関数
foo_colの場合、コンフィギュレーション パラメーターのカスタム コードでslSetColumnMajor("NS1::NS2::foo_col")を使用します。すべてのクラス メンバーについて、クラス名と入れ子にされた名前空間が関数名 string に含まれている必要があります。上記のコードに基づくと、行優先関数
foo_rowの場合、コンフィギュレーション パラメーターのカスタム コードでslSetRowMajor("NS1::ACLASS::foo_row")を使用します。
クラスを使用する C Function ブロックでは、コンストラクターで優先方向を受け取る場合、優先方向を [開始] コードで指定する必要があります。
例
Integrate External C++ Code Using Class with Custom Constructor in Simulink
How to integrate external C++ code using class with custom constructor in Simulink.
Use Simulink Strings Inside C Function Block to Model Scrolling Display
How to use Simulink Strings for C Function block.
C Function ブロック内の開始アクションと終了アクション
C Function ブロックを使用して、開始アクションと終了アクションをもつレガシ C 関数を統合する。
C Function ブロックを使用したレガシ ルックアップ テーブル関数の呼び出し
C Function ブロックを使用して N 次元のテーブル ルックアップを実装するレガシ C 関数を呼び出す。
永続シンボルを使用した C Function ブロックの状態の変更
ブロックにキャッシュされる永続値の初期値を定義する。
C Function ブロックからの C スタイルのラッパー関数を使用した C++ クラス メソッドの呼び出し
C Function ブロックで、C スタイルのラッパー関数を使用して C++ クラス メソッドを呼び出す。
C Function ブロックからの C++ クラス メソッドの直接呼び出し
C Function ブロックから C++ クラス メソッドを直接呼び出す。
制限
C Function ブロックで Simulink の次の機能を使用する場合、制限が適用されます。
一般的な制限事項
以下はすべての Simulink バージョンに適用される一般的な制限事項です。
R2025a 以降では、コード カバレッジがサポートされます。
R2025a より前のバージョンでは、Simulink Coverage™ はサポートされていません。C Function ブロックの実行カバレッジのみが計測されます。
Simulink Design Verifier™
Simulink Design Verifier は C Function ブロック内のカバレッジ オブジェクティブのテスト ケースを生成しません。C/C++ S-Function に適用される制限は C Function ブロックの C/C++ コードにも適用されます。特に、外部関数またはライブラリ関数の呼び出しは分析のためにスタブに置き換えられます。これらの制限の詳細については、S-Function と C/C++ コードに対する Simulink Design Verifier の制限事項と考慮事項 (Simulink Design Verifier)を参照してください。
Simulink Code Inspector™
Simulink Code Inspector は、C Function ブロックから生成されたコードを検査しません。
ローカル カスタム コードを使用する C Function ブロックは、Dataflow Subsystem (DSP System Toolbox) 内ではサポートされていません。
C および C++言語の制限事項
以下の制限事項は、R2025b 以前のバージョンの C Function ブロックで指定する C および C++ コードに適用されます。以下のブロック設定の場合は、R2026a 以降のバージョンにもこれらの制限が適用されます。
[カスタム コード設定を構成します]
パラメーターが [コンフィギュレーション パラメーターのカスタム コードを使用]に設定されている。[カスタム コード設定を構成します]
パラメーターが [ブロックのカスタム コードを使用]に設定され、[ブロック コードの解析 (下位互換性を有効にする)] パラメーターが選択されている。
メモ
これらの制限は、R2026a 以降のバージョンにおいて、既定の設定の C Function ブロックで指定した C/C++ コードには適用されません。既定の設定は、[カスタム コード設定を構成します] パラメーターが [ブロックのカスタム コードを使用] に設定され、[ブロック コードの解析 (下位互換性を有効にする)] パラメーターが選択されていない場合に適用されます。
C Function ブロックが上記の制限の条件に当てはまる場合、ブロックは以下の C 数学ライブラリ関数のみをサポートします。
abs | acos | asin | atan | atan2 | ceil |
cos | cosh | exp | fabs | floor | fmod |
labs | ldexp | log | log10 | pow | sin |
sinh | sqrt | tan | tanh |
これらの関数を呼び出すとき、すべての入力引数が明示的に単精度でなければ、倍精度が適用されます。型の不一致が発生した場合、必要な型に入力引数をキャストすると、元の引数が置換されます。たとえば、関数 sin を整数の引数で呼び出した場合は、入力引数を double 型の浮動小数点数にキャストすることで、元の引数が置換されます。
R2025a 以降のバージョンを使用している場合、C function ブロック内で以下の文字列ライブラリ関数を呼び出すことができます。
strlen | strncpy | strncat | strcmp | strncmp | strstr |
詳細については、Use Simulink Strings Inside C Function Block to Model Scrolling Displayを参照してください。
その他の C ライブラリ関数を呼び出すには、その C ライブラリ関数を呼び出す外部ラッパー関数を作成して呼び出します。
abs、fabs、labs 関数C Function ブロックでの関数 abs、fabs および labs の解釈は、以下に示す整数および浮動小数点の引数に対応している点で標準的な C バージョンよりも優れています。
xが整数の場合、標準 C 関数absはxに適用され、abs(x)となります。xが double の場合、標準 C 関数labsはxに適用され、labs(x)となります。xが single の場合、標準 C 関数fabsはxに適用され、fabs(x)となります。
関数の呼び出しでは、関数に渡されるデータ型に基づいて正しい CRL が呼び出されます。CRL が指定されない場合、関数の呼び出しで型固有のライブラリが呼び出されます。C99 の CRL は、型固有の関数を生成します。以下に例を示します。
| 渡される型 | コード生成の呼び出し |
|---|---|
sin(doubleIn) | sin(doubleIn) |
sin(floatIn) | sinf(floatIn) |
R2023a 以降のバージョンを使用している場合、C Function ブロックで printf、memcpy、および memset 関数を呼び出すことができます。
staticキーワードを使用するローカルの静的変数はサポートされません。タイム ステップを超えて値をキャッシュするには、シンボルをブロック ダイアログ ボックスの [シンボル] テーブルで[Persistent]として定義します。[Constant]シンボルのアドレスを取ることはサポートされません。C ライブラリ関数にリストされている C 数学ライブラリ関数以外の C ライブラリ関数を直接呼び出すことはサポートされません。その他の C ライブラリ関数を呼び出すには、その C ライブラリ関数を呼び出すラッパー関数を作成して呼び出します。
端子
入力
出力
パラメーター
[シミュレーション] タブと [コード生成] タブの両方に共通のパラメーター。
[カスタム コード設定を構成します] パラメーターを使用して、ブロック内のカスタム コードをローカルで指定するか、[コンフィギュレーション パラメーター] ダイアログ ボックスで指定するかを選択します。 アイコンの横にある矢印をクリックしてオプションを選択します。
ブロックのカスタム コードを使用
このオプションは、R2024a 以降のバージョンで利用できます。このオプションは、カスタム コードを C Function ブロック内でローカルに指定する場合に使用します。これは既定の設定です。このオプションにより、[シミュレーション] セクションと [コード生成] セクションの [シミュレーションのカスタム コード] パラメーターと [コード生成のカスタム コード] パラメーターがそれぞれ有効になります。
R2025a 以降では、ローカルで指定されたカスタム コードに対してコード カバレッジがサポートされます。コード カバレッジを使用するには、Simulink Coverage のライセンスが必要です。
コンフィギュレーション パラメーターのカスタム コードを使用
このオプションは、[モデル コンフィギュレーション パラメーター] ダイアログ ボックスの [シミュレーション ターゲット] ペインでカスタム コードを指定する場合に使用します。詳細については、モデル コンフィギュレーション パラメーター: Simulation Targetを参照してください。
プログラムでの使用
ブロック パラメーター: CustomCodeSettingLocation |
| 型: 文字ベクトル |
値: 'BlockSettings' | 'ModelConfigurationParameters' |
既定の設定: 'BlockSettings' |
C コードで使用するシンボルとシンボル プロパティ。table として指定します。各シンボルの次の属性を table で入力する必要があります。
名前 — コード内のシンボル名。
シンボルが C++ クラス オブジェクトを表す場合、[名前] フィールドはクラス コンストラクターの呼び出しとして機能します。
ObjectName(Argument1,Argument2,...)
スコープ — シンボルのスコープ。次のスコープが使用できます。
Input— ブロックへの入力。Output— ブロックへの出力。InputOutput— ブロックへの入力と出力の両方。[InputOutput]スコープを使用して、C コードでポインター渡しされた入力をマッピングします。[InputOutput]スコープを使用して作成された端子の名前は、入力端子と出力端子で同じです。[InputOutput]スコープを使用すると、入力端子と出力端子のバッファーの再利用が有効になります。バッファーを再利用すると、信号のサイズとブロック レイアウトに応じて、メモリの使用量が最適化され、コードのシミュレーションとコード生成の効率が向上する可能性があります。次のような制限があります。[InputOutput]シンボルは [開始]、[初期化条件]、または [終了] で使用できません。[InputOutput]シンボルではvoid*データ型はサポートされません。[InputOutput]シンボルではsize()式はサポートされません。
Parameter— ブロック パラメーター マスクに表示されるブロック パラメーター。パラメーターの名前は、シンボルの [ラベル] で定義されます。Persistent— シミュレーション中のタイム ステップ間で値が保持される永続ブロック データ。Persistentスコープを使用して void ポインターを定義できます。"void ポインター" は、作成する、または割り当てるあらゆる型のデータを格納できるポインターです。Persistentスコープのシンボルを定義し、そのシンボルの [タイプ] としてClass:ClassNameを使用することで、カスタム コードで定義されている C++ クラスのオブジェクトをインスタンス化できます。Interface with C++ Classes Using C Function Blockを参照してください。Constant— 値とサイズの式、または数値式を使用して定義する定数値。
ラベル — シンボルのラベル。
[Input]、[InputOutput]、または[Output]スコープのシンボルでは、このラベルはブロックの端子名として表示されます。[Parameter]スコープのシンボルでは、このラベルはブロック パラメーター マスクに表示されます。スコープが[Constant]の場合、ラベルは定数式です。[Persistent]スコープのシンボルにラベルを定義することはできません。タイプ — シンボルのデータ型。ドロップダウン リストからデータ型を選択するか、またはカスタム データ型を指定します。
メモ
R2025a 以降では、ブロックで
Input、Output、InputOutput、およびPersistentのスコープに対して Simulink の string 型がサポートされます。カスタム コードで定義されている C++ クラス タイプは、
Simulink.Bus型、Simulink Enum 型、およびSimulink.AliasType型と同様にサポートされます。[タイプ] は次の表に示すように入力します。カスタム型 [タイプ] フィールドでの指定 C++ クラス Class:C++ClassNameSimulink.BusBus:BusTypeNameSimulink.EnumEnum:EnumTypeNameSimulink.AliasTypeAliasTypeNameサイズ — シンボル データのサイズ。サイズ式を使用して出力のサイズを定義することも、
-1を使用してサイズを継承することもできます。端子 — シンボルの端子インデックス。
[Input]、[InputOutput]、または[Output]シンボルでは、[端子] はシンボルに対応する 1 つ以上の端子のブロックにおける端子インデックスを指定します。[Parameter]シンボルの場合、[端子] はブロック パラメーター マスクにシンボルが表示される順序を指定します。
プログラムでの使用
ブロック パラメーター: SymbolSpec |
型: SymbolSpec オブジェクト |
値: SymbolSpec オブジェクト |
既定の設定: Symbol オブジェクトの空の配列 |
サンプル周期。秒単位で指定します。サンプル時間のタイプおよびサンプル時間の指定を参照してください。ブロックで永続シンボルが定義されている場合、連続サンプル時間は指定できません。
プログラムでの使用
ブロック パラメーター: SampleTime |
| 型: 文字ベクトル | string スカラー |
既定の設定: "-1" |
このオプションは、ブロックが互いに干渉することなく、モデル内の複数の C Function ブロックで同じカスタム コードをローカルに指定できる場合に選択します。たとえば、内部状態を含む数学カウンターを使用する場合、コードの複数のインスタンスが互いに干渉する可能性があります。
このオプションを選択すると、次のモデル化のシナリオがサポートされます。
C Function ブロックでカスタム コードをローカルに指定し、For Each サブシステム内でブロックを使用する。
連続サンプル時間を使用する C Function ブロックでカスタム コードをローカルに指定する。
同じカスタム コードの複数のインスタンス用にコードを生成する。コードの各インスタンスは、モデル内の C Function ブロックでローカルに指定されます。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。[詳細設定] セクションを展開します。
プログラムでの使用
ブロック パラメーター: CustomCodeIsMultiInstantiable |
| 型: 文字ベクトル | string スカラー |
既定の設定: 'off' |
R2026a 以降
ブロックは、シミュレーションに必要な型定義を含む C/C++ コードを生成できます。
このパラメーターがオフになっていると、ブロックはインポートされたバス型、列挙型、およびエイリアス タイプについて、シミュレーションに必要な型定義を生成しません。利用可能なヘッダー ファイルで、これらのインポートされた型に対するシミュレーション互換の型定義が既に提供されています。
このパラメーターは、インポートされた列挙型、バス型、またはエイリアス タイプに対して、シミュレーション互換の型定義を含む利用可能なヘッダー ファイルがない場合に選択します。このパラメーターがオンになっていると、ブロックはこれらのインポートされた型の型定義をシミュレーション中に生成します。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。次に、[詳細設定] セクションを展開します。
プログラムでの使用
ブロック パラメーター: SimGenImportedTypeDefs |
| 型: 文字ベクトル | string スカラー |
既定の設定: 'off' |
R2026a 以降
このパラメーターがオフになっていると、ブロックはエクスポートされたバス型、列挙型、およびエイリアス タイプの型定義を生成し、シミュレーションを可能にします。
このパラメーターは、インクルードされたヘッダー ファイルに、エクスポートされるバス型、列挙型、エイリアス タイプの型定義が既に含まれている場合に選択します。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。次に、[詳細設定] セクションを展開します。
プログラムでの使用
ブロック パラメーター: SimDisableGenExportedTypeDefs |
| 型: 文字ベクトル | string スカラー |
既定の設定: 'off' |
R2026a 以降
R2025b 以前のバージョンでは、指定したすべてのカスタム コードがブロックで解析されました。ただし、パーサーでは C++ 言語に提供されるサポートが限られており、統合できる C++ コードが制限されていました。これらの制限については、C および C++言語の制限事項およびLimitationsにリストされています。
R2026a 以降、既定では、ブロック内でローカルに指定した C/C++ コードはブロックで解析されません。C++ コードを制限なく指定できます。ただし、[コンフィギュレーション パラメーター] ダイアログ ボックスでコードを指定すると、ブロックでは引き続きコードが解析され、制限が適用されます。
このパラメーターは、必要な場合にのみ選択します。たとえば、R2025b 以前のバージョンから R2026a 以降のバージョンに変更する際に下位互換性を維持する場合などです。このパラメーターを選択すると、Simulink はブロックでローカルに指定された C/C++ コードを解析し、エラー条件を検出して診断を提供します。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。次に、[詳細設定] セクションを展開します。
プログラムでの使用
ブロック パラメーター: ParseBlockCode |
| 型: 文字ベクトル | string スカラー |
既定の設定: 'off' |
シミュレーション
ブロックがシミュレーション中に各タイム ステップで実行する出力コード。文字ベクトルまたは string スカラーとして指定します。たとえば、このパラメーターを使用して、外部 C コードから関数を呼び出し、結果に変更を加え、他のブロックに結果を渡す操作を実行します。
プログラムでの使用
ブロック パラメーター: OutputCode |
| 型: 文字ベクトルまたは string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
ブロックがシミュレーションの開始時に 1 回実行する初期化コード。たとえば、このパラメーターを使用して永続シンボルを初期化します。
プログラムでの使用
ブロック パラメーター: StartCode |
| 型: 文字ベクトル | string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
ブロックが配置されているサブシステムまたはモデルをイネーブルにする際にブロックが実行する再初期化コード。コードはシミュレーションの開始時に 1 回実行されます。[イネーブル時の状態] パラメーターが [リセット] に設定されている Enable ブロックを含むサブシステムまたはモデル内にこのブロックがある場合、コードはこのサブシステムまたはモデルがディセーブルからイネーブルに切り替わるたびにも実行されます。Enabled Subsystem の使用を参照してください。たとえば、このコードを使用して、初期出力値を設定したり永続変数の値をリセットしたりできます。
プログラムでの使用
ブロック パラメーター: InitializeConditionsCode |
| 型: 文字ベクトル | string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
ブロックがシミュレーションの終了時に 1 回実行する終了コード。たとえば、このコードを使用して、void ポインターとして指定された永続シンボルについてキャッシュされたメモリを解放します。
プログラムでの使用
ブロック パラメーター: TerminateCode |
| 型: 文字ベクトル | string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
カスタム コードのヘッダー ファイルをローカルで指定します。このパラメーターは、[シミュレーションのカスタム コード] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomHeaderFile |
| 型: 文字ベクトル | string スカラー |
| 値: ヘッダー ファイル名または #include ステートメント |
既定の設定: "" |
カスタム コードのソース ファイルをローカルで指定します。このパラメーターは、[シミュレーションのカスタム コード] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomSourceFile |
| 型: 文字ベクトル | string スカラー |
| 値: 任意のファイル名 |
既定の設定: "" |
スタティック ライブラリまたは共有ライブラリのリストをローカルで指定します。このパラメーターは [シミュレーションのカスタム コード] セクションにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomLibraries |
| 型: 文字ベクトル | string スカラー |
| 値: 任意のライブラリ ファイル名 |
既定の設定: "" |
カスタム コードのヘッダー ファイルとソース ファイルを含むディレクトリをローカルで指定します。このパラメーターは [シミュレーションのカスタム コード] セクションにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomSearchDirectory |
| 型: 文字ベクトル | string スカラー |
| 値: 任意のフォルダー パス |
既定の設定: "" |
コンパイラ コマンド ラインに追加するプリプロセッサ マクロ定義をローカルで指定します。このパラメーターは [シミュレーションのカスタム コード] セクションの [詳細設定] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomDefines |
| 型: 文字ベクトル |
| 値: プリプロセッサ マクロ定義 |
既定の設定: '' |
コンパイラ コマンド ラインに追加する追加フラグをローカルで指定します。このパラメーターは [シミュレーションのカスタム コード] セクションの [詳細設定] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomCompilerFlags |
| 型: 文字ベクトル |
| 値: コンパイラ フラグ |
既定の設定: '' |
リンカー コマンド ラインに追加する追加フラグをローカルで指定します。このパラメーターは [シミュレーションのカスタム コード] セクションの [詳細設定] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: SimCustomLinkerFlags |
| 型: 文字ベクトル |
| 値: リンカー フラグ |
既定の設定: '' |
メモ
モデルにカスタム コードが含まれる場合、モデルが更新または実行されると、読み込まれたカスタム コードのシミュレーション実行可能ファイルが原因で slprj フォルダーがロックされる場合があります。ロックされているフォルダーは削除できません。実行可能ファイルをアンロードして、slprj フォルダーのロックを解除するには、clear mex コマンドを使用します。clearを参照してください。
コード生成
[コード生成] タブのパラメーターには、Simulink Coder™ または Embedded Coder® のライセンスが必要です。
シミュレーションとコード生成に同じコードを使用するか異なるコードを使用するかを指定します。既定では、このオプションは選択されており、ブロックはシミュレーションとコード生成に同じコードを使用します。シミュレーションとコード生成に異なるコードを使用するには、このオプションをオフにします。
プログラムでの使用
ブロック パラメーター: CodegenUsesSimCustomCode |
| 型: 文字ベクトル | string スカラー |
既定の設定: 'on' |
コード生成コードの解析を許可するかどうかを指定します。既定では、このオプションは選択されており、ブロックは解析せずに生成コードにコードを埋め込みます。このオプションをオフにすると、ブロックがコードを解析し、エラーをレポートするようになります。
シミュレーションとコード生成に異なるコードを使用した場合、このパラメーターは既定の設定を使用します。
依存関係
R2026a 以降のバージョンでは、このオプションを無効にできるのは、以下のパラメーターが両方とも選択されている場合のみです。
[カスタム コード設定を構成します]
パラメーターが [コンフィギュレーション パラメーターのカスタム コードを使用]に設定されている。[シミュレーションと同じコードを使用] パラメーターが選択されている。
R2026a より前: このオプションは、[カスタム コード設定を構成します] パラメーターの選択内容に関係なく、[シミュレーションと同じコードを使用] パラメーターが選択されている場合に無効にできます。
プログラムでの使用
ブロック パラメーター: GenerateCodeAsIs |
| 型: 文字ベクトル | string スカラー |
既定の設定: 'on' |
ブロックがコード生成中に各タイム ステップで実行する出力コード。たとえば、このパラメーターを使用して、外部 C/C++ コードから関数を呼び出し、結果に変更を加え、他のブロックに結果を渡す操作を実行します。
プログラムでの使用
ブロック パラメーター: CodegenOutputCode |
| 型: 文字ベクトルまたは string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
ブロックがコード生成の開始時に 1 回実行する初期化コード。たとえば、このパラメーターを使用して永続シンボルを初期化します。
プログラムでの使用
ブロック パラメーター: CodegenStartCode |
| 型: 文字ベクトル | string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
ブロックが配置されているサブシステムまたはモデルをイネーブルにする際にブロックが実行する再初期化コード。コードはコード生成の開始時に 1 回実行されます。[イネーブル時の状態] パラメーターが [リセット] に設定されている Enable ブロックを含むサブシステムまたはモデル内にこのブロックがある場合、コードはこのサブシステムまたはモデルがディセーブルからイネーブルに切り替わるたびにも実行されます。Enabled Subsystem の使用を参照してください。たとえば、このコードを使用して、初期出力値を設定したり永続変数の値をリセットしたりできます。
プログラムでの使用
ブロック パラメーター: CodegenInitializeConditionsCode |
| 型: 文字ベクトル | string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
ブロックがコード生成の終了時に 1 回実行する終了コード。文字ベクトルまたは string スカラーとして指定します。たとえば、このコードを使用して、void ポインターとして指定された永続シンボルについてキャッシュされたメモリを解放します。
プログラムでの使用
ブロック パラメーター: CodegenTerminateCode |
| 型: 文字ベクトル | string スカラー |
値: "" | C/C++ code |
既定の設定: "" |
カスタム コードのヘッダー ファイルをローカルで指定します。このパラメーターは [コード生成のカスタム コード] セクションにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomHeaderFile |
| 型: 文字ベクトル | string スカラー |
| 値: ヘッダー ファイル名または #include ステートメント |
既定の設定: "" |
カスタム コードのソース ファイルをローカルで指定します。このパラメーターは [コード生成のカスタム コード] セクションにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomSourceFile |
| 型: 文字ベクトル | string スカラー |
| 値: 任意のファイル名 |
既定の設定: "" |
スタティック ライブラリまたは共有ライブラリのリストをローカルで指定します。このパラメーターは [コード生成のカスタム コード] セクションにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomLibraries |
| 型: 文字ベクトル | string スカラー |
| 値: 任意のライブラリ ファイル名 |
既定の設定: "" |
カスタム コードのヘッダー ファイルとソース ファイルを含むディレクトリをローカルで指定します。このパラメーターは [コード生成のカスタム コード] セクションにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomSearchDirectory |
| 型: 文字ベクトル | string スカラー |
| 値: 任意のフォルダー パス |
既定の設定: "" |
コンパイラ コマンド ラインに追加するプリプロセッサ マクロ定義をローカルで指定します。このパラメーターは [コード生成のカスタム コード] セクションの [詳細設定] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomDefines |
| 型: 文字ベクトル |
| 値: プリプロセッサ マクロ定義 |
既定の設定: '' |
コンパイラ コマンド ラインに追加フラグを追加します。このパラメーターは [コード生成のカスタム コード] セクションの [詳細設定] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomCompilerFlags |
| 型: 文字ベクトル |
| 値: コンパイラ フラグ |
既定の設定: '' |
リンカー コマンド ラインに追加フラグを追加します。このパラメーターは [コード生成のカスタム コード] セクションの [詳細設定] タブにあります。
依存関係
このパラメーターを有効にするには、[カスタム コード設定を構成します] パラメーターを [ブロックのカスタム コードを使用] に設定します。
プログラムでの使用
ブロック パラメーター: CustomLinkerFlags |
| 型: 文字ベクトル |
| 値: リンカー フラグ |
既定の設定: '' |
メモ
モデルにカスタム コードが含まれる場合、モデルが更新または実行されると、読み込まれたカスタム コードのシミュレーション実行可能ファイルが原因で slprj フォルダーがロックされる場合があります。ロックされているフォルダーは削除できません。実行可能ファイルをアンロードして、slprj フォルダーのロックを解除するには、clear mex コマンドを使用します。clearを参照してください。
ブロックの特性
ヒント
インポートされた型が C++ 名前空間で定義されている場合は、次のいずれかのオプションを使用します。
Simulink.importExternalCTypes関数のSimulinkTypeAliasHeader引数を使用して、インポートされたヘッダー ファイルの型シグネチャに対応する型エイリアスを含む型エイリアス ヘッダーを生成します。次に、[シミュレーションのカスタム コード] タブの [ヘッダー] セクションで、生成したヘッダー ファイルを指定します。詳細については、SimulinkTypeAliasHeaderを参照してください。Simulink.importExternalCTypes関数のUseFullyQualifiedName引数を使用して、一意の型名で型を再インポートします。たとえば、異なる名前空間に定義されている同じ型をインポートする場合に、この引数を使用できます。詳細については、UseFullyQualifiedNameを参照してください。Simulink.importExternalCTypes関数のDataDictionarySection引数を使用して、ヘッダーから Simulink データ ディクショナリの [Architectural Data] セクションに型をインポートします。型をインポートすると、その対応する名前空間が自動的に同期されます。ただし、1 つの名前空間に同じ名前の型を 2 つインポートすることはできません。詳細については、DataDictionarySectionを参照してください。
拡張機能
バージョン履歴
R2020a で導入
C Function ブロックで、
Input、Output、InputOutput、およびPersistentのスコープに対して Simulink の string 型がサポートされるようになりました。文字列ライブラリ関数のサブセットを呼び出せるようになりました。サポートされる文字列ライブラリ関数の詳細については、C および C++言語の制限事項を参照してください。
ローカルで指定されたカスタム コードに対してコード カバレッジがサポートされるようになりました。ブロックのダイアログ ボックスでカスタム コードをローカルで指定するには、[カスタム コード設定を構成します]
パラメーターの [ブロックのカスタム コードを使用]を選択します。
ブロックのダイアログ ボックスとパラメーターに次の変更が加えられました。
ブロックのダイアログ ボックスに 2 つの新しいタブ [シミュレーション] と [コード生成] が追加されました。
[出力コード]、[開始コード]、[初期化条件コード]、[終了コード] パラメーターはそれぞれ、[出力]、[開始]、[初期化コード]、[終了] と呼ばれるようになりました。
[カスタム コード設定を構成します]
ボタンに、2 つのドロップダウン オプション [ブロックのカスタム コードを使用]と[コンフィギュレーション パラメーターのカスタム コードを使用]がリストされるようになりました。これらのオプションを使用して、カスタム コードを [ブロック パラメーター] ダイアログ ボックスでローカルに指定するか、[コンフィギュレーション パラメーター] ダイアログ ボックスを使用してカスタム コードを Simulink に統合するかを指定します。[シンボル] テーブルが [端子とパラメーター] テーブルになりました。
[シンボル] テーブルの [サイズ] 列が [端子とパラメーター] テーブルの [次元] 列になりました。
