モデルアドバイザーの設定エディターを使用したモデルアドバイザーのカスタマイズ

モデルアドバイザーの設定エディターの概要

モデルアドバイザーの設定エディターは、編集時のチェックに使用するチェック、およびモデルアドバイザーに含まれるチェックを指定する方法を提供しています。この組織的階層は、コンフィギュレーションファイルとして保存され、モデルアドバイザー開始時に読み込まれます。モデルアドバイザーの設定エディターを使用して、既存のコンフィギュレーションの変更、新規モデルアドバイザー設定の作成、既定のコンフィギュレーションの指定を行えます。

モデルアドバイザーの設定エディターは、次の機能を提供することにより、モデルアドバイザー解析を組織の要件に合わせて柔軟にカスタマイズできるようにします。

すべての使用可能なモデルアドバイザーチェックを確認する。
モデルアドバイザーツリーに内蔵されているチェックおよびフォルダーを追加、削除、整理する。
カスタムモデルアドバイザーチェックを検証および確認ワークフローに統合する。
チェックおよびフォルダーの無効化および有効化。
チェックとフォルダーの名前を変更する。
モデルアドバイザー解析中にチェックにフラグが付けられるとき、警告としてマークされるか、失敗とマークされるかを指定する。
モデルアドバイザー設定の読み込み時に、欠けているチェックについての警告メッセージが表示されないようにする。

モデルアドバイザーの設定エディターには、以下が含まれます。

[ライブラリ] ペイン — 読み取り専用ペイン。コンフィギュレーションで使用できるすべてのチェックおよびフォルダーが、[製品別] タブと [タスク別] タブに示されています。[ライブラリ] タブを常に表示するには、ツールストリップ上で [ライブラリを表示] をクリックします。
[モデルアドバイザー] ペイン — このペインには、現在のモデルアドバイザー設定のチェックおよびフォルダーのリストが表示されます。このリストは以下で絞り込まれます。
- All checks ― 現在の構成に含まれるすべてのモデルアドバイザーチェック
- Edit time supported checks ― 編集時チェックでサポートされるモデルアドバイザーチェックのみ
[情報] タブ — このタブには、チェックおよびフォルダーの詳細が表示されます。これには、表示名、チェックのタイトルおよび ID、説明、ライセンス要件、サブチェック、入力パラメーターなどが含まれます。

[ライブラリ] および [モデルアドバイザー] ペインの検索機能を使用して、特定のチェックおよびフォルダーを見つけます。

モデルアドバイザーの設定エディター

モデルアドバイザーの設定エディターの開始

モデルアドバイザーの設定エディターを開く前に、現在のフォルダーが書き込み可能かどうかを確認します。フォルダーが書き込み可能でない場合、モデルアドバイザーの設定エディターを起動するとエラーメッセージが表示されます。

モデルアドバイザー API を使用してカスタムチェックまたはモデルアドバイザーのカスタマイズを実装するときは、まず、Simulink^® 環境を更新して sl_customization.m ファイルを含めなければなりません。MATLAB^® コマンドラインで以下のように入力します。

Advisor.Manager.refresh_customizations

次のいずれかの方法を使用して、モデルアドバイザーの設定エディターを開きます。

プログラムから ― MATLAB コマンドラインで Simulink.ModelAdvisor.openConfigUI を入力する。
Simulink エディターから ― [モデル化] タブで、[モデルアドバイザー] 、 [モデルアドバイザーの設定エディター] を選択する。
モデルアドバイザーから ― [設定] 、 [設定エディターを開く] を選択する。

モデルアドバイザーの設定エディターを開くと、モデルアドバイザーによって現在使用されているコンフィギュレーションファイルが表示されます。コンフィギュレーションファイル名はウィンドウ上部に表示されます。正しい設定ファイルを評価していることを確認してください。別の設定ファイルを開くには、[開く] をクリックし、確認するファイルを参照します。

新しいコンフィギュレーションを作成するには、ツールストリップの [新規] ボタンをクリックします。[名前を付けて保存] を使用してコンフィギュレーションファイルの名前を変更します。モデルアドバイザー設定ファイルは .json 形式で保存されます。

既定のコンフィギュレーションファイルの指定

モデルアドバイザーの設定エディターを使用して、モデルアドバイザーが開くときに自動的に読み込まれる既定のコンフィギュレーションを指定できます。既定のコンフィギュレーションを設定するには、モデルアドバイザーの設定エディターでコンフィギュレーションファイルを開き、ツールストリップで [既定に設定] ボタンをクリックします。

メモ

既定のコンフィギュレーションを以前に指定したことがある場合、[既定のコンフィギュレーション設定のクリア] を使用して現在の既定のコンフィギュレーションファイルを指定している設定をクリアできます。このボタンをクリックしても、モデルアドバイザーの設定エディターに現在表示されているコンフィギュレーションは変わりません。既定のコンフィギュレーションを指定しない場合、モデルアドバイザーは、システム管理者によって定義される標準のコンフィギュレーションを使用します。

コンフィギュレーションファイルを既定として指定しない場合、ファイルを保存するとき、ファイルを既定のコンフィギュレーションにするかどうかの確認が表示されます。そのファイルを既定のコンフィギュレーションにするには、[はい] をクリックします。

モデルアドバイザー設定のカスタマイズ

モデルアドバイザーの設定エディターを使用して、モデルアドバイザー設定ツリーをカスタマイズできます。これには、チェックおよびフォルダーの追加と削除、チェック実行順序の指定などが含まれます。また、ユーザーがチェックを解析に含めたり除外したりできる機能を無効にすることもできます。モデルアドバイザーの設定エディターを使用して、チェックの入力パラメーターを定義できます。

メモ

[ライブラリ] タブからコピーされたチェックには、既定のパラメーター設定が保持されています。カスタムコンフィギュレーションフォルダーにペーストされると、各チェックの横のボックスはオフになります。

[モデルアドバイザー] タブのフォルダーからコピーされるか切り取られたチェックは、そのユーザー定義パラメーター設定を保持します。チェックが複数のフォルダーに含まれるとき、各チェックに個別に異なるパラメーターを指定できます。

階層の整理

モデルアドバイザー設定ツリー内のチェックおよびフォルダーのレイアウトを以下を使用してカスタマイズできます。

新規フォルダー - フォルダーを作成する。
コピー、切り取り、貼り付け - チェックおよびフォルダーを追加、コピー、および移動する。
削除 - チェックおよびフォルダーを削除する。
上に移動、または下に移動 - コンフィギュレーションツリー内のチェックまたはフォルダーの位置をずらす。コンフィギュレーションツリーの高い位置にあるフォルダーおよびチェックは、解析で先に実行されます。

チェックの有効化と無効化

モデルアドバイザーの設定エディターを使用して、モデルアドバイザーのチェックおよびフォルダーのチェックボックス制御を無効にすることができます。そうすることで、モデルアドバイザー設定ツリーにチェックはリスト表示されますがグレー表示になり、解析にチェックを追加したり削除したりできなくなります。

[モデルアドバイザー] ペインで、フォルダーまたはチェックで右クリックし、[無効] を選択します。モデルアドバイザーの設定エディターのチェックボックスの選択状態により、モデルアドバイザーでは次のような結果になります。

モデルアドバイザーの設定エディターのチェックの横のボックスがオンの場合、モデルアドバイザーのチェックは自動的に選択されます。[無効] を選択したので、チェックはグレー表示され、解析からこのチェックを削除することはできません。
チェックの横のボックスがグレー表示になってい "ない" 場合、かつ [無効] オプションがモデルアドバイザーの設定エディターに適用されている場合、モデルアドバイザーにはチェックが選択されておらず、解析に含めることはできません。
モデルアドバイザーの設定エディターで、フォルダーの横のボックスがオンの場合、モデルアドバイザーにおいてフォルダー内のチェックが自動的に選択されます。ここでは [無効] を選択したため、フォルダーとそのチェックがグレー表示され、解析からチェックを削除しようとしてもできません。
フォルダーの横のボックスが選択されてい "ない" 場合、かつ [無効] オプションがモデルアドバイザーの設定エディターに適用される場合、モデルアドバイザーで、フォルダー内のいずれのチェックも選択されず、解析に含めることはできません。

チェックまたはフォルダーが無効になっているとき、[有効] オプションを使用して、解析にチェックを含めるかどうかをユーザーに決めさせることができます。

メモ

[有効] と [無効] は、モデルアドバイザーユーザーインターフェイスと編集時のチェックの両方において、解析時のチェックの実行に影響を与えます。

チェックをカスタマイズするパラメーターの指定

モデルアドバイザーの設定エディターを使用して、モデルアドバイザーチェックをカスタマイズできます。たとえば、チェックの表示名、入力パラメーターなどです。

[情報] タブで、チェックについてカスタマイズできる内容を確認します。

表示名 — チェックにモデルアドバイザーに表示される新しい名前を付けます。表示名を変更しても、チェックのタイトルは変更されないことに注意してください。
問題にフラグが設定されている場合は結果をチェック — チェックによってモデルの問題にフラグが付けられるとき、結果を警告とマークするか、失敗とマークするかを指定します。既定値は [警告] です。[失敗] を選択すると、フラグが付けられたチェックは結果で失敗とマークされます。
入力パラメーター — チェックに追加の特性や機能を加えます。モデルアドバイザーはこれらのパラメーターを使用して解析の重点をさらに定義します。たとえば、モデルアドバイザーチェック Check indentation of code in Stateflow statesの解析に、サブチェック jc_0736_b のみを選択して、許容される半角スペースの数を指定することができます。

欠けているチェックについての警告メッセージの非表示

モデルアドバイザーは、モデルアドバイザー設定を読み込むときに欠けているチェックについて自動的に警告を出します。モデルアドバイザーの設定エディターを使用してこのメッセージを非表示にすることができます。[モデルアドバイザーの設定エディター] のルートノードを選択し、[情報] タブで [構成を読み込む際に、欠けているチェックについての警告メッセージを非表示にします。] を選択します。

あるいは、モデルアドバイザーの警告をプログラムによって非表示にすることもできます。その場合、MATLAB コマンドラインに次のコマンドを入力します。

warning('off','Simulink:tools:MALoadConfigMissCorrespondCheck')

モデルアドバイザーの設定エディターを使用したカスタムモデルアドバイザー設定の作成

ライブスクリプトを開く

モデルアドバイザーの設定エディターを使用して、モデルアドバイザーの階層を整理し、チェック解析に含まれるチェックを指定できます。この例では、新しいコンフィギュレーションファイルを作成し、モデルアドバイザーおよび編集時のチェック用のチェックを指定し、チェックパラメーターを定義し、モデルアドバイザーにコンフィギュレーションを読み込む方法について説明します。

現在のディレクトリへのモデルのコピー

モデル AdvisorCustomizationExample.slx とそのサポートファイル (カスタムのモデルアドバイザー設定ファイル demoConfiguration.json を含む) を書き込み可能ディレクトリにコピーします。

1.MATLAB で、現在のフォルダーを書き込み可能なディレクトリに設定します。

2.MATLAB コマンドプロンプトに以下のコマンドを入力します。MATLAB により、サンプルファイルが書き込み可能なディレクトリにコピーされます。

copyfile(fullfile(matlabroot,'examples','slcheck','main','prepare_cust_chk_code.m'),...
    'prepare_cust_chk_code.m','f');
run('prepare_cust_chk_code.m');

モデルを開き、モデルアドバイザー設定を確認

この例では、モデルアドバイザーチェックの情報キャッシュを更新し、モデルを開き、モデルアドバイザー設定を確認します。特に、コンフィギュレーションがモデルアドバイザーユーザーインターフェイスと編集時のチェックに与える影響について確認します。

1.モデルアドバイザーチェックの情報キャッシュを更新するには、MATLAB コマンドプロンプトで以下を入力します。

Advisor.Manager.refresh_customizations();

2.モデル例を開きます。

open_system('AdvisorCustomizationExample.slx');

3.[モデル化] タブで [モデルアドバイザー] を開きます。MATLAB コマンドプロンプトに以下を入力しても、モデルアドバイザーを開くことができます。

modeladvisor('AdvisorCustomizationExample.slx');

Updating Model Advisor cache...
Model Advisor cache updated. For new customizations, to update the cache, use the Advisor.Manager.refresh_customizations method.

4.[タスク別] タブで、以下のチェックの横のボックスがオンになっていることを確認します。

[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[ブロック名での文字の使用をチェック]
[MAB のモデリング標準]、[Simulink]、[ブロック線図の外観]、[ブロック名がブロックの下になっているかどうかをチェック]

5.[MAB のモデリング標準] フォルダーで右クリックして、[選択したチェックを実行] を選択します。結果において、両方のチェックが警告でマークされていることに注意します。モデルアドバイザーの使用方法の詳細については、モデルアドバイザーチェックの実行と結果の確認を参照してください。

6.Simulink モデルエディターに戻ります。

7.[モデル化] タブで、[モデルアドバイザー]、[編集時チェック] オプションが選択されていることを確認します。Logical Operator ブロックが強調表示されていることを観察します。ブロックの上にある警告アイコンをクリックし、編集時のチェック項目違反を表示します。詳細については、編集時チェックを使用したモデルの準拠性のチェックを参照してください。

モデルアドバイザー設定の読み込み

この例では、例 AdvisorCustomizationExample.slx に同梱されているモデルアドバイザー設定ファイルを読み込みます。モデルアドバイザー設定ファイルの形式は、.json (R2020a 以降) または .mat (R2019b 以前) が可能です。

1.カスタムコンフィギュレーションファイルを読み込むには、[設定]、[設定の読み込み] を選択し、使用するコンフィギュレーションを選択します。この例では、前に指定した書き込み可能ディレクトリから demoConfiguration.json を選択します。モデルアドバイザーが新しいコンフィギュレーションで更新され、ウィンドウ上部にコンフィギュレーションファイルの名前が表示されます。

2.モデルアドバイザーを調べ、このコンフィギュレーションでは 3 つのチェックのみが利用できることを観察します。

3.コンフィギュレーションファイル demoConfiguration.json を既定のモデルアドバイザー設定として指定するには、[設定]、[現在の設定を既定の設定にする] を選択します。

既定のコンフィギュレーション設定をクリアするには、[設定]、[既定のコンフィギュレーション設定のクリア] を選択します。既定のコンフィギュレーションを指定しない場合、モデルアドバイザーは、システム管理者によって定義される標準のコンフィギュレーションを使用します。

新規モデルアドバイザー設定の作成

この例では、demo_Configuration_ISO26262_MAB.json という名前のカスタムコンフィギュレーションファイルを作成します。このコンフィギュレーションファイルは、モデルアドバイザーユーザーインターフェイスを使用して実行する MathWorks Advisory Board (MAB) モデリングガイドラインチェックを定義するために使用します。

1.モデル AdvisorCustomizationExample.slx で、demoConfiguration.json が現在のコンフィギュレーションであるモデルアドバイザーとチェックを開きます。

2.[設定]、[設定エディターを開く] を選択し、モデルアドバイザーの設定エディターを開きます。

メモ: モデルアドバイザーの設定エディターを開くと、モデルアドバイザーキャッシュに現在読み込まれているファイルが自動的に表示されます。

3.[新規作成] をクリックします。[モデルアドバイザー] ペインで、All checks を選択します。これにより、現在表示されているコンフィギュレーションは、モデルアドバイザーユーザーインターフェイスのすべてのチェックに対するものとして指定されます。

4.モデルアドバイザーの設定エディターのルートフォルダーを強調表示して、[新規フォルダー] をクリックします。新しいフォルダーを選択し、[情報] タブで表示名を ISO 26262 Standard Checks に変更します。[適用] をクリックします。

5.ツールストリップで [ライブラリを表示] を選択し、[ライブラリ] ペインを表示します。[製品別] タブの検索フィールドに ISO 26262 と入力します。

6.Simulink Check > Modeling Standards > IEC 61508, IEC 62304, ISO 26262, EN 50128, and ISO 25119 Checks フォルダーで右クリックして [コピー] を選択します。カスタムの ISO 26262 規格チェックフォルダーを右クリックし、[貼り付け] をクリックします。フォルダーおよびチェックがカスタムコンフィギュレーションフォルダーにコピーされたことを確認します。

メモ: [ライブラリ] ペインからコピーされたチェックでは、既定のパラメーター設定が保持されています。カスタムコンフィギュレーションフォルダーにペーストされると、各チェックの横のボックスはオフになります。

7.[モデルアドバイザー] ペインの [タスク別] フォルダーで、Modeling Standards for MAB folder を右クリックし、[切り取り] を選択します。モデルアドバイザーの設定エディターのルートフォルダーをクリックし、[貼り付け] をクリックします。フォルダーは [タスク別] フォルダーから削除され、モデルアドバイザーの設定エディターのルートフォルダーに新しいサブフォルダーとして追加されます。

メモ: [モデルアドバイザー] ペインのフォルダーからコピーされるか切り取られたチェックは、ユーザー定義のパラメーター設定を保持します。チェックが複数のフォルダーに含まれるとき、各チェックに個別に異なるパラメーターを指定できます。

8.ISO 26262 Standard Checks フォルダーを選択し、[下に移動] ボタンを使用して階層内のフォルダーの位置を変更します。モデルアドバイザーは Modeling Standards for MAB フォルダー内のチェックを最初に実行します。

9.[製品別] および [タスク別] フォルダーを選択し、[削除] を選択します。

10.[名前を付けて保存] をクリックし、コンフィギュレーションファイルの名前を demo_Configuration_ISO26262_MAB に変更します。プロンプトで [はい] を選択し、コンフィギュレーションを既定の構成として保存します。ファイルは自動的に .json 形式で保存されます。

メモ: 既定のコンフィギュレーションを以前に指定している場合、[既定のコンフィギュレーション設定のクリア] を使用して現在の既定のコンフィギュレーションファイルを指定しているフラグをクリアできます。このボタンをクリックしても、モデルアドバイザーの設定エディターに現在表示されているコンフィギュレーションは変わりません。

11.モデルアドバイザーの設定エディターと AdvisorCustomizationExample.slx モデルを閉じます。

12.モデルアドバイザーキャッシュを更新し、MATLAB コマンドラインに次のコマンドを入力して、モデル AdvisorCustomizationExample.slx を開きます。

Advisor.Manager.refresh_customizations();
open_system('AdvisorCustomizationExample.slx');

13.コンフィギュレーションファイル demo_Configuration_ISO26262_MAB.json が使用されているモデルアドバイザーおよびチェックを開きます。モデルアドバイザーに、フォルダー Modeling Standards for MAB および ISO 26262 Standard Checks が表示されます。

モデルアドバイザーチェックの指定

この例では、カスタムコンフィギュレーションファイル demo_Configuration_ISO26262_MAB.json のチェックをカスタマイズし、そのカスタマイズが AdvisorCustomizationExample.slx モデルのモデルアドバイザー解析に与える影響を確認します。

1.[モデル化] タブで、[モデルアドバイザー]、[モデルアドバイザーの設定エディター] をクリックします。また、必要な場合、demo_Configuration_ISO26262_MAB.json を開きます。

2.[モデルアドバイザー] ペインで、コンフィギュレーションのフォーカスが All checks に設定されていることを確認します。

3.[モデルアドバイザーの設定エディター] のルートノードフォルダーの横にあるチェックボックスをクリアします (この手順はオプションです。しかし、チェックをオフにすることで、モデルアドバイザーの設定エディターを使用してモデルアドバイザーに表示するチェックを指定した結果をより簡単に確認できるようになります)。

4.モデルアドバイザーユーザーインターフェイスでモデルアドバイザー解析に含めるチェックを指定できるようにするため、[モデルアドバイザーの設定エディター] ルートフォルダーを右クリックし、[有効] をクリックします (メモ: [有効] は既定の設定です。無効になっているチェックがない場合、このオプションはグレー表示されています)。

5.[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[ブロック名での文字の使用をチェック] チェックの横のボックスをオンにします。

6.以下の各チェックを右クリックし、[無効] を選択します。

[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[ブロック名での文字の使用をチェック]
[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[サブシステム名の長さをチェック]

7.[MAB のモデリング標準]、[Simulink]、[ブロック線図の外観]、[ブロック名がブロックの下になっているかどうかをチェック] チェックをクリックし、[情報] タブの [問題にフラグが設定されている場合は結果をチェック] オプションで Fail を選択します。[適用] をクリックします。

メモ: [問題にフラグが設定されている場合は結果をチェック] オプションの既定値は Warning です。

8.[保存] をクリックしてコンフィギュレーションを保存します。モデルアドバイザーの設定エディターとモデルを閉じます。

9.モデルアドバイザーキャッシュを更新し、MATLAB コマンドラインに次のコマンドを入力して、モデル AdvisorCustomizationExample.slx を開きます。

Advisor.Manager.refresh_customizations();
open_system('AdvisorCustomizationExample.slx');

10.モデルアドバイザーを開き、コンフィギュレーションファイル demo_Configuration_ISO26262_MAB.json が使用されていることを確認します。

これらのチェックが、モデルアドバイザーの設定エディターで選択した設定を反映して、次のようになっていることを観察します。

[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[ブロック名での文字の使用をチェック] はグレー表示されており、チェックボックスはオンになっている。このチェックはモデルアドバイザー解析で常に実行されます。グレー表示されているため、解析から除外することはできません。
[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[サブシステム名の長さをチェック] がグレー表示されており、チェックボックスはオフになっている。このチェックは解析に含まれません。グレー表示されているため、解析に含めるよう選択することはできません。

11.[MAB のモデリング標準]、[Simulink]、[ブロック線図の外観]、[ブロック名がブロックの下になっているかどうかをチェック] チェックの横のボックスをオンにします。

12.モデルアドバイザー解析を実行するには、[MAB のモデリング標準] ルートノードを右クリックし、[選択したチェックを実行] を選択します。

13.以下のチェックをクリックし、モデルアドバイザー解析結果を確認します。

[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[ブロック名での文字の使用をチェック] チェックが警告アイコンでマークされており、結果によりチェック項目違反が Gain ブロックにあることが示されている。
[MAB のモデリング標準]、[命名規則]、[コンテンツ]、[サブシステム名の長さをチェック] チェックは、解析に選択できないため、結果がない。
[MAB のモデリング標準]、[Simulink]、[ブロック線図の外観]、[ブロック名がブロックの下になっているかどうかをチェック] チェックは失敗アイコンでマークされている。モデルアドバイザーの設定エディターを使用してこのチェック設定を指定したため、この動作は意図されたものです。

編集時のチェック用のチェックの指定

この例では、編集時のチェックの実行において demo_Configuration_ISO26262_MAB.json コンフィギュレーションファイルで利用できるチェックを指定します。

1.モデル AdvisorCustomizationExample.slx の [モデル化] タブで、[モデルアドバイザー]、[編集時チェック] オプションがオンになっていることを確認します。

2.[モデル化] タブで [編集時チェックのカスタマイズ] をクリックします。モデルアドバイザーの設定エディターが開きます。このとき、コンフィギュレーションフォーカスオプションは Edit-Time supported checks になっています。モデルアドバイザーチェックのサブセットのみが編集時のチェックでサポートされます。Edit-Time supported checks オプションは、編集時のチェックをサポートするチェックのみを表示します。

3.[モデルアドバイザー] ペインで、[MAB のモデリング標準]、[Simulink]、[演算ブロック]、[Logical Operator ブロックのアイコン形状をチェック] チェックの横のボックスをオンにします。

4.[保存] をクリックしてコンフィギュレーションを保存します。モデルアドバイザーの設定エディターを閉じます。AdvisorCustomizationExample.slx モデルに戻ります。

5.Simulink エディターで、Logical Operator ブロックが強調表示されていることに注目してください。違反を開き、[修正] をクリックします。モデルアドバイザーによりブロックが矩形形状に変更され、強調表示された編集時チェック警告がクリアされます。

参考

ModelAdvisor.setDefaultConfiguration | ModelAdvisor.Check