カスタムモデルアドバイザーチェックの定義

カスタムチェックを定義して、モデルアドバイザーで確認する独自の条件やモデル構成設定を作成します。編集時およびモデルアドバイザーで実行されるカスタムチェックとモデルアドバイザーでのみ実行されるカスタムチェックを作成できます。

カスタム編集時チェックは、問題をモデル設計プロセスの早い段階で特定するのに役立ちますが、ユーザーが編集しているモデルまたはサブシステムの同じレベルにあるブロックと信号しか確認されません。ただし、これらのチェックではモデルの階層構造のレベルで問題が集約され、その問題がモデルアドバイザーで報告されます。モデルの他のレベルにある影響を受けるブロックについてチェックで確認する必要がある場合は、モデルアドバイザーでのみ実行されるカスタムチェックを作成します。たとえば、モデルの階層構造全体で From ブロックと Goto ブロックの不一致についてチェックで確認する必要がある場合は、このチェックをモデルアドバイザーでのみ実行するように定義します。

次の手順は、編集時に実行されるチェックとモデルアドバイザーでのみ実行されるチェックを作成するプロセスを示したものです。

関数 sl_customization の作成
カスタムチェックの登録
チェック定義関数の作成
1. ModelAdvisor.Check クラスのインスタンスの作成
2. カスタムモデルアドバイザーチェックの定義またはカスタム編集時チェックの定義の手順に従ってカスタムチェックを定義します。
3. チェック入力パラメーターの定義
4. カスタムチェックのパブリッシュ

関数 sl_customization の作成

カスタムチェックを定義するには、まず、MATLAB パスに sl_customization.m ファイルを作成します。sl_customization.m ファイルの中に、関数 sl_customization を作成します。関数 sl_customization では、1 つの引数 (カスタマイズマネージャーオブジェクト) を受け入れます。

function sl_customization(cm)

ヒント

MATLAB パス上に複数の sl_customization.m ファイルを配置することができます。
モデルアドバイザーのチェックとフォルダーをカスタマイズする sl_customization.m ファイルは、ルート MATLAB^® フォルダーやそのサブフォルダー (matlabroot/work フォルダーを除く) には配置しないでください。配置した場合、モデルアドバイザーはファイルで指定されているカスタマイズを無視します。

カスタムチェックの登録

カスタムチェックを登録するには、addModelAdvisorCheckFcn メソッドを使用します。これは、関数 sl_customization に入力するカスタマイズマネージャーオブジェクトの一部です。次のコードは関数 sl_customization.m のサンプルを示しています。

function sl_customization(cm)
% register custom checks 
cm.addModelAdvisorCheckFcn(@defineModelAdvisorChecks);

% -----------------------------
% defines Model Advisor Checks
% -----------------------------
function defineModelAdvisorChecks
defineDetailStyleCheck;
defineConfigurationParameterCheck;
defineNewBlockConstraintCheck;
defineEditTimeChecks;

addModelAdvisorCheckFcn メソッドは、モデルアドバイザーの [製品別] フォルダーにチェックを登録します。defineModelAdvisorChecks 引数は、カスタムチェックを定義する関数の呼び出しを含む関数のハンドルです。カスタムモデルアドバイザーチェックについては、作成するチェックごとに 1 つのチェック定義関数を作成する必要があります。編集時チェックにはそれぞれ独自のクラス定義が含まれるため、複数の編集時チェックに作成するチェック定義関数は 1 つでかまいません。カスタムチェックを定義する関数の詳細については、モデルアドバイザーカスタム構成の作成と展開を参照してください。

チェック定義関数の作成

チェック定義関数は、チェック実行時にモデルアドバイザーが行うアクションを定義します。以降の節では、カスタムの編集時チェックとモデルアドバイザーでのみ実行されるチェックのチェック定義関数について、それらの主要なコンポーネントを説明します。

`ModelAdvisor.Check` クラスのインスタンスの作成

各カスタムチェックごとに、ModelAdvisor.Check クラスのインスタンスを 1 つ作成します。ModelAdvisor.Check プロパティおよびメソッドを使用して、チェックのユーザーインターフェイスとアクションを定義します。次の表は、主要なチェックコンポーネントの一部を示しています。

内容	説明
チェック ID (必須)	チェックを一意に識別します。モデルアドバイザーはこの ID を使用してチェックにアクセスします。
(カスタムモデルアドバイザーチェックのみ) チェックコールバック関数のハンドル (必須)	チェックの内容を指定する関数です。
(カスタムモデルアドバイザーチェックのみ) アクションコールバック関数のハンドル (オプション)	修正アクションを追加します。
(カスタム編集時チェックのみ) クラスのハンドル (必須)	編集時チェックのアクションを定義する派生クラス。必要に応じて、このクラスで編集時チェックの修正も定義できます。
チェック名 (推奨)	モデルアドバイザーでのチェックの名前を指定します。
モデルのコンパイル (オプション)	チェック解析用にモデルをコンパイルするかどうかを指定します。`CallbackContext` プロパティの値 `PostCompileForCodegen` は編集時チェックではサポートされません。
入力パラメーター (オプション)	ユーザーによる入力を要求する入力パラメーターを追加します。モデルアドバイザーはこの入力を使用してチェックを実行します。

警告

ModelAdvisor.Check クラスの継承によるカスタムチェックの作成はサポートされているワークフローではありません。ModelAdvisor.Check のプロパティには一般に大文字小文字の区別がありませんが、継承クラスのチェックのプロパティには大文字小文字の区別があるためです。

カスタムモデルアドバイザーチェックの定義

モデルアドバイザーでのみ表示されるカスタムチェックのチェック定義関数には、モデルまたはサブシステムに対してモデルアドバイザーで実行するアクションを指定するチェックコールバック関数が含まれています。チェックコールバック関数を定義し、そのハンドルを setCallbackFcn メソッドに受け渡します。チェックを実行すると、モデルアドバイザーはコールバック関数を実行します。チェック実行後、コールバック関数は結果を表示する戻り引数を 1 つ以上提供します。チェックを実行すると、モデルアドバイザーはコールバック関数を実行します。

カスタムチェックの修正を指定する場合、チェック定義関数にはアクションコールバック関数も含める必要があります。チェック定義関数内で、ModelAdvisor.Action クラスのインスタンスを作成します。アクションコールバック関数を定義し、そのハンドルを setCallbackFcn メソッドに受け渡します。モデルアドバイザーでチェックのユーザーが [修正] をクリックすると、それらのモデルにカスタムの修正が適用されます。

Custom Model Advisor check with a fix

コールバック関数およびアクションコールバック関数から、チェックの実行後に結果を表示するための戻り引数が 1 つ以上返されます。チェックコールバック定義関数とアクションコールバック定義関数の作成を参照してください。

モデルアドバイザーの結果に既定の書式設定を使用するには、setCallbackFcn メソッドでコールバック関数のタイプを DetailStyle に指定します。既定の書式設定では要件が満たされない場合、ModelAdvisor.FormatTemplate クラスまたは以下の他のモデルアドバイザーの書式設定クラスのいずれかを使用します。

クラス	説明
`ModelAdvisor.Text`	モデルアドバイザーのテキスト出力を作成します。
`ModelAdvisor.List`	リストを作成します。
`ModelAdvisor.Table`	テーブルを作成します。
`ModelAdvisor.Paragraph`	段落を作成し、書式設定します。
`ModelAdvisor.LineBreak`	改行を挿入します。
`ModelAdvisor.Image`	モデルアドバイザーの出力にイメージを含めます。

カスタム編集時チェックの定義

カスタム編集時チェックを作成するには、ModelAdvisor.EdittimeCheck クラスから派生する MATLAB クラスを作成します。チェック定義関数で、このクラスを ModelAdvisor.Check の CallbackHandle プロパティの値として指定します。派生クラス内で、次のメソッドを定義します。

チェック ID とチェックの ModelAdivsor.EdittimeCheck.TraversalType プロパティを指定するメソッドを定義します。TraversalType プロパティは、モデルアドバイザーでのチェックの実行方法を指定します。
編集時アルゴリズムに違反するブロックを探す blockDiscovered メソッドを定義します。
ブロックに違反があった場合に、そのブロックを編集時に強調表示するには、Type プロパティを既定値の SID に設定して ModelAdvisor.ResultDetail 違反オブジェクトを作成します。信号に違反があった場合に、その信号を強調表示するには、Type プロパティを Signal に設定して違反オブジェクトを作成します。
edittimecheck.TraversalTypes.ACTIVEGRAPH の TraversalType プロパティを指定する場合は、編集時チェックで収集したデータに対して実行する内容を指定する finishedTraversal メソッドを blockDiscovered メソッドの一部として定義します。
必要に応じて、編集時チェックの違反に対する fix メソッドを定義します。

例については、編集時チェックを定義し、モデルアドバイザーで指定した条件に準拠させるを参照してください。

モデルの編集中にカスタム編集時チェックがパフォーマンスに悪影響を及ぼさないように、現在の MATLAB セッションにおいて、少なくとも 3 つの異なる Simulink^® モデルでチェックの実行時間が 500 ミリ秒を超えると、モデルアドバイザーではカスタム編集時チェックが自動的に無効になります。

モデルアドバイザーでカスタム編集時チェックが無効になると Simulink キャンバスに警告が表示されます。編集時チェックを再度有効にするには、次のいずれかを行います。

警告のハイパーリンクテキストをクリックします。
次のように関数edittime.enableCheckにチェック識別子 checkID を渡します。edittime.enableCheck(checkID)。

カスタム編集時チェックが無効にならないようにするには、モデルでのチェックの実行時間が 500 ミリ秒を超えないようにチェックを作成してください。

チェック入力パラメーターの定義

入力パラメーターを使用して、チェックの実行前に入力を要求できます。入力パラメーターは ModelAdvisor.InputParameter クラスを使用して定義します。カスタムチェック定義関数に入力パラメーターの定義を組み込まなければなりません。カスタムチェックに追加する入力パラメーターごとに、このクラスのインスタンスを 1 つ定義する必要があります。

次のメソッドを使用して、モデルアドバイザーでの入力パラメーターのレイアウトを指定します。

目的	メソッド
入力パラメーターグリッドのサイズを指定します。	`setInputParametersLayoutGrid`
入力パラメーターレイアウトグリッド内のパラメーターの行数を指定します。	`setRowSpan`
入力パラメーターレイアウトグリッド内のパラメーターの列数を指定します。	`setColSpan`

入力パラメーターはモデルアドバイザーの [入力パラメーター] ボックスに表示されます。

Model Advisor check with input parameters

チェックの表示と有効化

カスタムチェックがモデルアドバイザーにどのように表示されるかを指定することができます。どの場合にチェックを表示するか、またユーザーによるチェックの選択や選択解除を許可するかどうかを、ModelAdvisor.Check クラスの Visible、Enable、Value の各プロパティを使用して指定できます。これらのプロパティには次のような相互関係があります。

Visible プロパティが false の場合、チェックまたはタスクがモデルアドバイザーに表示されず、Enable プロパティと Value プロパティは無視されます。
Visible プロパティが true で Enable プロパティが false の場合、次のようになります。
- チェックがモデルアドバイザーに表示されます。
- チェックの初期ステータスは Value になります。
- チェックボックスはグレー表示になります。
Visible プロパティが true で Enabled プロパティが true の場合、チェックまたはタスクがモデルアドバイザーに表示され、チェックボックスがアクティブになります。

カスタムチェックの登録

カスタムチェックを登録するには、次のコマンドを使用します。

Advisor.Manager.refresh_customizations

カスタムチェックのパブリッシュ

publish メソッドを使用して、[製品別] フォルダー内にカスタムチェック用のフォルダーを作成します。モデルアドバイザールートで利用可能なカスタムで作成されたパブリッシュ済みのチェックが新しいフォルダーに格納され、それらのチェックがモデルアドバイザーツリーに表示されます。次に、モデルアドバイザー構成エディターを使用して、モデルアドバイザーツリー内のフォルダーをカスタマイズし、カスタム構成を作成します。詳細については、モデルアドバイザー構成エディターを使用したモデルアドバイザーのカスタマイズを参照してください。

モデルアドバイザー構成 API Advisor.Config を使用して、モデルアドバイザールートで利用可能なパブリッシュ済みのカスタムチェックを含むカスタム構成をプログラムで作成することもできます。addFolder 関数を使用してカスタム構成用のカスタムフォルダーを作成し、addCheck 関数を使用してそのフォルダーにカスタムチェックを追加できます。詳細については、Customize Model Advisor Configuration Programmaticallyを参照してください。

参考

ModelAdvisor.Check | ModelAdvisor.EdittimeCheck | ModelAdvisor.InputParameter | ModelAdvisor.Action | publish