ブロックのコールバック

ブロックが読み込まれるとき、開かれるとき、編集されるときなどにブロックイベントの MATLAB^® コードを実行するブロックコールバックを指定できます。

[モデル化] タブの [設計] で、[プロパティインスペクター] をクリックします。
コールバックを指定するブロックを選択します。
プロパティインスペクターの [プロパティ] タブの [コールバック] セクションで、定義するコールバックを選択します。
ボックス内に、コールバックで実行する関数を入力します。

ブロックコールバックをプログラムで指定するには、set_param 関数を使用して、MATLAB コードをブロックコールバックパラメーターに割り当てます。

モデリングアクションが起こる前か起こった後にブロックのコールバックが実行される場合、そのコールバックはモデリングアクションの直前または直後に発生します。

LoadFcn、ContinueFcn、InitFcn、ModelCloseFcn、PauseFcn、PostSaveFcn、PreSaveFcn、StartFcn、および StopFcn の各コールバックは、アクティベーションのタイミングが [ブロック線図の更新] である Variant Subsystem ブロックの非アクティブなバリアント選択肢およびコメント化されたブロックに対しては実行されません。この抑制により、計算のオーバーヘッドが軽減され、現在のモデルの反復に影響しないブロックからの不要な診断メッセージが回避されます。たとえば、find_system 関数で @Simulink.match.allVariants マッチフィルターを使用してアクティブと非アクティブのバリアント選択肢を特定する場合、Simulink^® は非アクティブなバリアント選択肢をリストしますが、LoadFcn コールバックを実行する対象はアクティブなバリアント選択肢のみになります。非アクティブなバリアント選択肢はモデルの実行に影響しないため、それらに対しては LoadFcn コールバックを実行しません。ただし、コメント化されているか非アクティブな Model ブロックや Subsystem Reference ブロック内にあるモデルまたはサブシステムファイル内のブロックに対しては、これらのコールバックは抑制されません。また、マスクの初期化およびマスクパラメータのコールバックも抑制されません。該当するコールバックの一覧については、Author Mask Initialization and Callbacksおよびマスクパラメーターを参照してください。

ブロックを開くコールバックパラメーター

ブロックのコールバックパラメーターコールバックが実行されるタイミング

ブロックのコールバックパラメーター	コールバックが実行されるタイミング
`OpenFcn`	ブロックを開くとき。一般に、このパラメーターは Subsystem ブロックで使用します。コールバックが実行されるのは、ブロックをダブルクリックしたときか、ブロックを引数として `open_system` 関数を使用したときです。`OpenFcn` コールバックは、ブロックを開く動作と関連した通常の動作、すなわちブロックダイアログボックスを表示するかサブシステムを開く動作をオーバーライドします。ブロックの変数を定義する目的で `OpenFcn` コールバックを使用できるタスクの例として、MATLAB を呼び出して、シミュレーション済みのデータのプロットを作成する場合や、グラフィカルユーザーインターフェイスを生成する場合が挙げられます。 `OpenFcn` コールバックをブロックに追加した後は、ブロックをダブルクリックしてもブロックダイアログボックスは開きません。また、ブロックを選択してもプロパティインスペクターにブロックパラメーターが表示されません。ブロックパラメーターを設定するには、ブロックのコンテキストメニューで [ブロックパラメーター] を選択します。
`LoadFcn`	ブロック線図が読み込まれた後。 `LoadFcn` コールバックは、すべてのブロックに対して、そのブロックがアクティブになるかコメント解除されると実行されます。冗長な実行を避けるために、`LoadFcn` コールバックは反復で一度実行されると、その後の反復でブロックが非アクティブからアクティブに遷移したときにもう一度トリガーされることはありません。 Subsystem ブロックの場合は、`LoadFcn` コールバックが定義されているサブシステム内のすべてのブロック (他の Subsystem ブロックを含む) に対して `LoadFcn` コールバックが実行されます。

OpenFcn

ブロックを開くとき。

一般に、このパラメーターは Subsystem ブロックで使用します。

コールバックが実行されるのは、ブロックをダブルクリックしたときか、ブロックを引数として open_system 関数を使用したときです。OpenFcn コールバックは、ブロックを開く動作と関連した通常の動作、すなわちブロックダイアログボックスを表示するかサブシステムを開く動作をオーバーライドします。ブロックの変数を定義する目的で OpenFcn コールバックを使用できるタスクの例として、MATLAB を呼び出して、シミュレーション済みのデータのプロットを作成する場合や、グラフィカルユーザーインターフェイスを生成する場合が挙げられます。

OpenFcn コールバックをブロックに追加した後は、ブロックをダブルクリックしてもブロックダイアログボックスは開きません。また、ブロックを選択してもプロパティインスペクターにブロックパラメーターが表示されません。ブロックパラメーターを設定するには、ブロックのコンテキストメニューで [ブロックパラメーター] を選択します。

LoadFcn

ブロック線図が読み込まれた後。

LoadFcn コールバックは、すべてのブロックに対して、そのブロックがアクティブになるかコメント解除されると実行されます。冗長な実行を避けるために、LoadFcn コールバックは反復で一度実行されると、その後の反復でブロックが非アクティブからアクティブに遷移したときにもう一度トリガーされることはありません。

Subsystem ブロックの場合は、LoadFcn コールバックが定義されているサブシステム内のすべてのブロック (他の Subsystem ブロックを含む) に対して LoadFcn コールバックが実行されます。

ブロックを編集するコールバックパラメーター

ブロックのコールバックパラメーター	コールバックが実行されるタイミング
`MoveFcn`	ブロックが移動またはサイズが変更されたとき。
`NameChangeFcn`	ブロックの名前やパスが変更された後。 Subsystem ブロックのパスが変更された場合、Subsystem ブロックは子孫のブロックの `NameChangeFcn` コールバックを呼び出してから、それ自体の `NameChangeFcn` コールバックを呼び出します。
`PreCopyFcn`	ブロックがコピーされる前。`PreCopyFcn` コールバックは、`add_block` 関数を使用してブロックをコピーする場合も実行されます。 `PreCopyFcn` コールバックが定義されたブロックを含む Subsystem ブロックをコピーした場合、そのコールバックも実行されます。 `CopyFcn` ブロックコールバックは、すべての `PreCopyFcn` コールバックが実行された後に呼び出されます。
`CopyFcn`	ブロックがコピーされた後。このコールバックは、`add_block` 関数を使用してブロックをコピーする場合も実行されます。 `CopyFcn` パラメーターが定義されたブロックを含む Subsystem ブロックをコピーした場合、そのコールバックも実行されます。
`ClipboardFcn`	ブロックがシステムクリップボードにコピーまたは切り取られたとき。
`PreDeleteFcn`	ブロックがグラフィカルに削除される前。たとえば、ブロックをグラフィカルに削除するときやブロックに対して `delete_block` 関数を呼び出すときです。 `PreDeleteFcn` コールバックは、ブロックを含むモデルを閉じるときは呼び出されません。`PreDeleteFcn` コールバックの後に `DeleteFcn` ブロックコールバックが呼び出されます。ただし、`PreDeleteFcn` コールバックで、明示的に、あるいは `PreDeleteFcn` コールバックで使用されるコマンドを介して `error` コマンドを呼び出す場合は除きます。
`DeleteFcn`	ブロックがグラフィカルに削除された後。たとえば、ブロックをグラフィカルに削除するとき、ブロックに対して `delete_block` 関数を呼び出すとき、ブロックを含むモデルを閉じるときです。 `DeleteFcn` コールバックが呼び出された時点では、ブロックハンドルはまだ有効であり、`get_param` 関数を使用してアクセスできます。`delete_block` 関数を呼び出すかモデルを閉じることでブロックをグラフィカルに削除すると、削除後にブロックがメモリから破棄され、`DestroyFcn` ブロックコールバックが呼び出されます。 Subsystem ブロックの場合は、`DeleteFcn` コールバックが定義されているサブシステム内のすべてのブロック (他の Subsystem ブロックを含む) に対して `DeleteFcn` コールバックが実行されます。
`DestroyFcn`	ブロックがメモリから破棄されたとき。たとえば、ブロックまたはブロックを含むサブシステムに対して `delete_block` 関数を呼び出すときやブロックを含むモデルを閉じるときです。ブロックがまだグラフィカルに削除されていない場合は、`DestroyFcn` コールバックの前に `DeleteFcn` ブロックコールバックが呼び出されます。`DestroyFcn` コールバックが呼び出されると、ブロックハンドルは有効でなくなります。
`UndoDeleteFcn`	ブロックの削除が元に戻されたとき。

ブロックのコンパイルおよびシミュレーションのコールバックパラメーター

ブロックのコールバックパラメーター	コールバックが実行されるタイミング
`InitFcn`	ブロック線図がコンパイルされる前とブロックパラメーターが評価される前。`InitFcn` コールバックの詳細については、初期化関数を参照してください。
`StartFcn`	ブロック線図がコンパイルされた後とシミュレーションを開始する前。 S-Function ブロックの場合、`StartFcn` コールバックは、ブロックの `mdlProcessParameters` 関数の最初の実行のすぐ前に実行されます。詳細については、S-Function コールバックメソッドを参照してください。
`ContinueFcn`	シミュレーションを継続する前。
`PauseFcn`	シミュレーションの一時停止時。
`StopFcn`	シミュレーションの終了時。 S-Function ブロックの場合、`StopFcn` コールバックはブロックの `mdlTerminate` 関数の実行後に実行されます。詳細については、S-Function コールバックメソッドを参照してください。

ブロックを保存するまたは閉じるコールバックパラメーター

ブロックのコールバックパラメーター	コールバックが実行されるタイミング
`PreSaveFcn`	ブロック線図を閉じる前。 Subsystem ブロックの場合は、`PreSaveFcn` コールバックが定義されているサブシステム内のすべてのブロック (他の Subsystem ブロックを含む) に対して `PreSaveFcn` コールバックが実行されます。
`PostSaveFcn`	ブロック線図を読み込んだ後。 Subsystem ブロックの場合は、`PostSaveFcn` コールバックが定義されているサブシステム内のすべてのブロック (他の Subsystem ブロックを含む) に対して `PostSaveFcn` コールバックが実行されます。
`CloseFcn`	ブロックを `close_system` 関数を使用して閉じるとき。 `CloseFcn` コールバックは、ブロックパラメーターのダイアログボックスを対話形式で閉じるとき、ブロックを含むサブシステムまたはモデルを対話形式で閉じるとき、ブロックを含むサブシステムまたはモデルを `close_system` 関数を使用して閉じるときは呼び出されません。たとえば、開いている MATLAB ウィンドウをすべて閉じるには、以下のようなコマンドを使用します。 set_param('my_model','CloseFcn','close all')
`ModelCloseFcn`	ブロック線図を閉じる前。モデルを閉じるときに、`DeleteFcn` または `DestroyFcn` のいずれかが設定されている場合、それらのブロックコールバックの前に `ModelCloseFcn` ブロックコールバックが呼び出されます。 Subsystem ブロックの場合は、`ModelCloseFcn` コールバックが定義されているサブシステム内のすべてのブロック (他の Subsystem ブロックを含む) に対して `ModelCloseFcn` コールバックが実行されます。

Subsystem ブロックコールバックパラメーター

他のブロックのコールバックパラメーターを Subsystem ブロックで使用できますが、次の表のコールバックパラメーターは Subsystem ブロックに固有のものです。

メモ

マスクサブシステムに対するコールバックでマスクサブシステムのパラメーターを直接参照することはできません。ブロックマスクの作成を参照してください。ソフトウェアでは MATLAB ベースワークスペースにあるブロックコールバックが評価されますが、一方マスクパラメーターはマスクサブシステムのプライベートワークスペースに存在します。ブロックコールバックでは get_param 関数を使用してマスクパラメーターの値を取得できます。たとえば、ここで、gain は現在のブロックにおけるマスクパラメーターの名前です。

get_param(gcb,'gain')

ブロックのコールバックパラメーターコールバックが実行されるタイミング

ブロックのコールバックパラメーター	コールバックが実行されるタイミング
`DeleteChildFcn`	ブロックまたはラインがサブシステムで削除された後。ブロックに `DeleteFcn` または `DestroyFcn` がある場合、それらのコールバックは `DeleteChildFcn` コールバックの前に実行されます。
`ErrorFcn`	エラーがサブシステム内で発生したとき。 `ErrorFcn` コールバックのコールバックコードには、次の形式を使用します。 newException = errorHandler(subsys,... errorType,originalException) ここで、 `errorHandler` は、関数名です。 `subsys` はエラーが発生したサブシステムのハンドル。 `errorType` は発生したエラーのタイプを示す文字ベクトル。 `originalException` は MSLException。詳細については、MSLException オブジェクトを使用した Simulink のエラー処理を参照してください。 `newException` は、ユーザーに対して表示されるエラーメッセージを指定する文字列。元の例外を発行する場合は、サブシステムやエラータイプの指定は不要です。次のコマンドでは、サブシステム `subsys` の `ErrorFcn` コールバックで `errorHandler` コールバックを呼び出すように設定しています。 set_param(subsys,'ErrorFcn','errorHandler') このような `set_param` 関数の呼び出しには、コールバックコードの入力引数は含めないでください。コールバックによって返されるエラーメッセージが表示されます。
`ParentCloseFcn`	ブロックを含むサブシステムを閉じる前または以下を使用してブロックを新しいサブシステムの一部にする際 `new_system` 関数 Simulink エディターの [複数] タブの [サブシステムの作成] アイコンモデルを閉じるとき、ルートモデルレベルにあるブロックの `ParentCloseFcn` コールバックは呼び出されません。

DeleteChildFcn

ブロックまたはラインがサブシステムで削除された後。

ブロックに DeleteFcn または DestroyFcn がある場合、それらのコールバックは DeleteChildFcn コールバックの前に実行されます。

ErrorFcn

エラーがサブシステム内で発生したとき。

ErrorFcn コールバックのコールバックコードには、次の形式を使用します。

newException = errorHandler(subsys,...
errorType,originalException)

ここで、

errorHandler は、関数名です。
subsys はエラーが発生したサブシステムのハンドル。
errorType は発生したエラーのタイプを示す文字ベクトル。
originalException は MSLException。詳細については、MSLException オブジェクトを使用した Simulink のエラー処理を参照してください。
newException は、ユーザーに対して表示されるエラーメッセージを指定する文字列。

元の例外を発行する場合は、サブシステムやエラータイプの指定は不要です。

次のコマンドでは、サブシステム subsys の ErrorFcn コールバックで errorHandler コールバックを呼び出すように設定しています。

set_param(subsys,'ErrorFcn','errorHandler')

このような set_param 関数の呼び出しには、コールバックコードの入力引数は含めないでください。コールバックによって返されるエラーメッセージが表示されます。

ParentCloseFcn

ブロックを含むサブシステムを閉じる前または以下を使用してブロックを新しいサブシステムの一部にする際

new_system 関数
Simulink エディターの [複数] タブの [サブシステムの作成] アイコン

モデルを閉じるとき、ルートモデルレベルにあるブロックの ParentCloseFcn コールバックは呼び出されません。