ドキュメンテーション

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

Simulink.ModelAdvisor

MATLAB ファイルからモデル アドバイザーを実行

説明

モデル アドバイザーを実行 (例: 標準的なチェックのセットを実行) するために、MATLAB® プログラムでこのクラスのインスタンスを使用します。MATLAB は、現在の MATLAB セッションで開いている各モデルに対して、このオブジェクトのインスタンスを作成します。モデルのモデル アドバイザー オブジェクトのハンドルを取得するには、次のコマンドを実行します。

ma = Simulink.ModelAdvisor.getModelAdvisor(model);

ここで、model は、チェックするモデルまたはサブシステムの名前です。実行すると、ユーザーのプログラムがモデル アドバイザー オブジェクトのメソッドを使って、モデル アドバイザーのチェックを初期化し、実行することができます。

ID について

多くの Simulink.ModelAdvisor オブジェクト メソッドは、ID を必要とするか、または返します。ID はモデル アドバイザー チェック、タスクまたはグループの一意の文字列識別子です。ID は定数になります。Simulink.ModelAdvisor オブジェクトには、すべてのチェック、タスク、グループの ID の取得、グループとタスクに属するチェックの取得、アクティブ チェックの取得、選択されたチェック、タスク、グループの取得をするメソッドが含まれます。

チェック ID は、モデル アドバイザーのチェック コンテキスト メニューを使用して知ることができます。

対象手順
チェックのタイトル、ID または MATLAB ソース コードの場所
  1. モデル アドバイザーのツール バーで、[設定][設定...] を選択します。

  2. [モデル アドバイザーの設定] ダイアログ ボックスで [[ソース] タブを表示] を選択します。

  3. モデル アドバイザー ウィンドウの右側のペインで [ソース] タブをクリックします。モデル アドバイザー ウィンドウにはチェックのタイトル、タイトル ID、MATLAB ソース コードの場所が表示されます。

チェック ID
  1. モデル アドバイザーの左側のペインでチェックを選択します。

  2. チェック名を右クリックして [ワークスペースにチェック ID を送信] を選択します。ID がコマンド ウィンドウに表示され、ベース ワークスペースに送信されます。

フォルダー内で選択されたチェックのチェック ID
  1. モデル アドバイザーの左側のペインで、ID を確認するチェックを選択します。フォルダー内にある他のチェックは選択を解除します。

  2. フォルダーを右クリックして [ワークスペースにチェック ID を送信] を選択します。選択したチェック ID の配列がベース ワークスペースに送信されます。

構文

ma = Simulink.ModelAdvisor

引数

ma

作成した Simulink.ModelAdvisor オブジェクトを表現する変数。

プロパティ

EmitInputParametersToReport

EmitInputParametersToReport プロパティはモデル アドバイザー レポートにチェックの入力パラメーターを表示するかどうかを指定します。

説明

'true' (既定の設定)

モデル アドバイザー レポートにチェックの入力パラメーターを表示します。

'false'

モデル アドバイザー レポートにチェックの入力パラメーターを表示しません。

メソッドのまとめ

名前

説明

closeReport

モデル アドバイザー レポートを閉じます。

deselectCheck

チェックの選択を解除します。

deselectCheckAll

すべてのチェックの選択を解除します。

deselectCheckForGroup

チェックのグループの選択を解除します。

deselectCheckForTask

指定したタスクまたはタスク セットのチェックの選択を解除します。

deselectTask

タスクの選択を解除します。

deselectTaskAll

すべてのタスクの選択を解除します。

displayReport

モデル アドバイザー レポートを表示します。

exportReport

指定された位置にレポートをコピーします。

filterResultWithExclusion

ユーザー定義の除外により除外されているオブジェクトをフィルター処理します。


getBaselineMode

モデル アドバイザーのベースライン モード設定を取得します。

getCheckAll

モデル アドバイザーが実行したチェックの ID を取得します。

getCheckForGroup

チェック グループのチェックを取得します。

getCheckForTask

タスクのチェックを取得します。

getCheckResult

チェック結果を取得します。

getCheckResultData

チェック結果のデータを取得します。

getCheckResultStatus

チェックまたはチェック セットの成功/失敗のステータスを取得します。

getGroupAll

モデル アドバイザーが実行したタスクのグループ ID を取得します。

getInputParameters

チェックの入力パラメーターを取得します。

getListViewParameters

チェックのリスト表示パラメーターを取得します。

getModelAdvisor

モデルまたはサブシステムのモデル アドバイザーを取得します。

getSelectedCheck

選択されたチェックを取得します。

getSelectedSystem

モデル アドバイザーで現在対象となっているシステムのパスを取得します。

getSelectedTask

選択されたタスクを取得します。

getTaskAll

モデル アドバイザーで実行したタスク ID を取得します。

Simulink.ModelAdvisor.openConfigUI

モデル アドバイザーの設定エディターを起動します。

Simulink.ModelAdvisor.reportexists

システムまたはサブシステムのレポートが存在するかどうかを判定します。

runCheck

選択されたチェックを実行します。

runTask

選択されたタスクのチェックを実行します。

selectCheck

チェックを選択します。

selectCheckAll

すべてのチェックを選択します。

selectCheckForGroup

チェックのグループを選択します。

selectCheckForTask

指定されたタスクのチェックを選択します。

selectTask

タスクを選択します。

selectTaskAll

すべてのタスクを選択します。

setActionEnable

チェック アクションのステータスを有効/無効にします。

setBaselineMode

モデル アドバイザーのベースライン モードを設定します。

setCheckErrorSeverity

チェックの失敗の重大度を設定します。

setCheckResult

現在実行しているチェックの結果を設定します。

setCheckResultData

現在実行しているチェックの結果のデータを設定します。

setCheckResultStatus

現在実行しているチェックの成功/失敗のステータスを設定します。

setListViewParameters

チェックのリスト表示パラメーターを設定します。

verifyCheckRan

チェックを実行したことを確認します。

verifyCheckResult

チェック結果のベースライン セットの作成、または現在の結果のセットをベースラインの結果と比較します。

verifyCheckResultStatus

モデルがチェック セットに成功/失敗したかを確認します。

verifyHTML

ベースライン レポートを生成するか現在のレポートをベースライン レポートと比較します。

メソッド

closeReport

目的

モデル アドバイザー レポートを閉じる

構文

closeReport

説明

モデル アドバイザー オブジェクトに関連するレポートを閉じ、モデル アドバイザー ウィンドウを閉じます。

参考

displayReport

deselectCheck

目的

チェックの選択を解除

構文

success = deselectCheck(ID)

引数

ID

選択を解除するチェック ID を指定する文字列またはセル配列。

success

チェックの選択を解除する場合は true (1)。

説明

このメソッドは、ID が指定するチェックの選択を解除します。

    メモ:   このメソッドは、無効なチェックの選択を解除できません。

参考

getCheckAll, deselectCheckForGroup, selectCheck

deselectCheckAll

目的

すべてのチェックの選択を解除

構文

success = deselectCheckAll

引数

success

すべてのチェックの選択を解除する場合は true (1)。

説明

使用可能なすべてのチェックの選択を解除します。

参考

selectCheckAll

deselectCheckForGroup

目的

チェックのグループの選択を解除

構文

success = deselectCheckForGroup(groupName)

引数

groupName

選択を解除するグループの名前を指定する文字列またはセル配列。

success

メソッドが指定したグループの選択を解除した場合は true (1)。

説明

指定したグループのチェックの選択を解除します。

参考

selectCheckForGroup

deselectCheckForTask

目的

指定したタスクまたはタスク セットのチェックの選択を解除

構文

success = deselectCheckForTask(ID)

引数

ID

チェックの選択を解除するタスク ID を指定する文字列または文字列のセル配列。

success

指定したタスクの選択を解除する場合は true (1)。

説明

ID 引数で指定されるタスクのチェックの選択を解除します。

参考

getTaskAll, selectCheckForTask

deselectTask

目的

タスクの選択を解除

構文

success = deselectTask(ID)

引数

ID

選択を解除するタスク ID を指定する文字列またはセル配列。

success

メソッドが指定したタスクの選択を解除した場合は true (1)。

説明

ID で指定したタスクの選択を解除します。

参考

selectTask, getTaskAll

deselectTaskAll

目的

すべてのタスクの選択を解除

構文

success = deselectTaskAll

引数

success

このメソッドがすべてのタスクの選択を解除した場合は true (1)。

説明

すべてのタスクの選択を解除します。

参考

selectTaskAll

displayReport

目的

モデル アドバイザーにレポートを表示

構文

displayReport

説明

モデル アドバイザー オブジェクトに関連するレポートを、モデル アドバイザー ウィンドウに表示します。このレポートは、モデル アドバイザー オブジェクトに関連するシステム上で実行するチェックの最新の結果を含みます。また、システムで現在選択しているチェック、グループ、タスクのステータスも含みます。

参考

Simulink.ModelAdvisor.reportexists

exportReport

目的

モデル アドバイザーが生成したレポートのコピーの作成

構文

[success message] = exportReport(destination)

引数

destination

レポート ファイルから作成されたコピーのパス名。

success

指定した位置にレポートのコピーを作成することができた場合は true (1)。

message

コピーが成功した場合は空、そうでない場合はコピー不成功の理由。

説明

このメソッドは、モデル アドバイザーが生成した最新のレポートのコピーを作成し、指定した位置に保存します。

参考

Simulink.ModelAdvisor.reportexists

filterResultWithExclusion

目的

ユーザー定義の除外により除外されているオブジェクトのフィルター処理

構文

filteredResultHandles = obj.filterResultWithExclusion(ResultHandles)

引数

filteredResultHandles

除外を有効にしたチェックの警告または失敗の原因となるオブジェクトの配列。

obj

Simulink.ModelAdvisor.getModelAdvisor オブジェクトを表す変数。

ResultHandles

チェックの警告または失敗の原因となるオブジェクトの配列。

説明

このメソッドは、除外を有効にしたチェックの警告または失敗の原因となるオブジェクトをフィルター処理します。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink® Verification and Validation™ で利用可能になる機能) で作成されたカスタム チェックからオブジェクトを除外するためのものです。

参考

getModelAdvisor

getBaselineMode

目的

モデル アドバイザーがベースライン データ生成モードであるかどうかを判定

構文

mode = getBaselineMode

引数

mode

ベースライン モードを示す論理値。

説明

出力変数 mode は、モデル アドバイザーがベースライン データ モードである場合は true を返します。ベースライン モードでは、モデル アドバイザーの確認メソッド (たとえば、verifyHTML) がベースライン データを作成します。

参考

setBaselineMode, verifyHTML, verifyCheckResult, verifyCheckResultStatus

getCheckAll

目的

すべてのチェック ID を取得

構文

IDs = getCheckAll

引数

IDs

モデル アドバイザーが実行したすべてのチェック ID を指定する文字列のセル配列。

説明

モデル アドバイザーが実行したすべてのチェック ID を指定する文字列のセル配列を返します。

参考

getTaskAll, getGroupAll

getCheckForGroup

目的

チェック グループのチェックを取得

構文

IDs = getCheckForGroup(groupName)

引数

groupName

グループ名を指定する文字列。

IDs

ID のセル配列。

説明

groupName で指定したグループのタスクとチェック ID のセル配列を返します。

参考

getCheckForTask

getCheckForTask

目的

タスクのチェックを取得

構文

checkIDs = getCheckForTask(taskID)

引数

taskID

タスク ID。

checkIDs

指定したタスクのチェック ID のセル配列。

説明

taskID が指定するタスクのチェック ID のセル配列を返します。

参考

getCheckForGroup

getCheckResult

目的

チェックまたはチェック セットの実行結果を取得

構文

result = getCheckResult(ID)

引数

ID

チェック ID、またはチェック ID のセル配列。

result

チェック結果またはチェック結果のセル配列。

説明

指定したチェック結果を取得します。結果の形式は、データを生成したチェックに依存します。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックで生成された結果にアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

getCheckResultData, getCheckResultStatus

getCheckResultData

目的

チェックまたはチェック セットの実行結果のデータを取得

構文

result = getCheckResultData(ID)

引数

ID

チェック ID、またはチェック ID のセル配列。

result

チェック結果からのデータまたはそのデータのセル配列。

説明

指定したチェックのチェック結果データを取得します。データの形式は、データを生成したチェックに依存します。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックで生成されたチェック結果データにアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

getCheckResult, getCheckResultStatus

getCheckResultStatus

目的

チェックまたはチェック セットのステータスを取得

構文

result = getCheckResultStatus(ID)

引数

ID

チェック ID、またはチェック ID のセル配列。

result

チェックまたはチェック セットの成功/失敗のステータスを示す Boolean または論理値のセル配列。

説明

チェック セットの実行後にこのメソッドを呼び出し、チェックが成功したか失敗したかどうかを判定します。

参考

getCheckResult, getCheckResultData

getGroupAll

目的

モデル アドバイザーが実行したすべてのグループのチェックを取得

構文

IDs = getGroupAll

引数

IDs

モデル アドバイザーが実行したすべてのグループのチェック ID のセル配列。

説明

モデル アドバイザーが実行したすべてのグループのチェック ID のセル配列を返します。

参考

getCheckAll, getTaskAll

getInputParameters

目的

チェックの入力パラメーターを取得

構文

params = obj.getInputParameters(check_ID)

引数

params

ModelAdvisor.InputParameter オブジェクトのセル配列。

obj

Simulink.ModelAdvisor オブジェクトを表す変数。

check_ID

チェックを一意に識別する文字列。

チェックのコールバック関数内のメソッドを使用する場合、check_ID を省略できます。

説明

チェックに関連する入力パラメーターを返します。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックにアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

ModelAdvisor.InputParameter

getListViewParameters

目的

チェックのリスト表示パラメーターを取得

構文

params = obj.getListViewParameters(check_ID)

引数

params

ModelAdvisor.ListViewParameter オブジェクトのセル配列。

obj

Simulink.ModelAdvisor オブジェクトを表す変数。

check_ID

チェックを一意に識別する文字列。

チェックのコールバック関数内のメソッドを使用する場合、check_ID を省略できます。

説明

チェックに関連するリスト表示パラメーターを返します。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックにアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

setListViewParameters, ModelAdvisor.ListViewParameter

getModelAdvisor

目的

システムまたはサブシステムのモデル アドバイザー オブジェクトを取得

構文

obj = Simulink.ModelAdvisor.getModelAdvisor(system)
obj = Simulink.ModelAdvisor.getModelAdvisor(system, 'new')

引数

system

モデルまたはサブシステムの名前。

'new'

前のセッションを閉じずに、モデル アドバイザーの対象システムを他のシステムへ変更する際に必要になります。'new' が省略できる場合は、getModelAdvisor を呼び出す前に前のセッションを閉じることができます。

obj

モデル アドバイザー オブジェクト。

説明

このスタティック メソッド (「静的メソッド」を参照) は、system で指定されるモデルまたはサンプル システムに対し、Simulink.ModelAdvisor クラスのインスタンスを作成して返します。

getSelectedCheck

目的

現在選択されたチェックを取得

構文

IDs = getSelectedCheck

引数

IDs

現在選択されているチェックの ID のセル配列。

説明

モデル アドバイザーで現在選択されているチェックの ID を返します。

参考

getSelectedTask

getSelectedSystem

目的

モデル アドバイザーで現在対象となっているシステムを取得

構文

path = getSelectedSystem

引数

path

選択されたシステムのパス。

説明

モデル アドバイザーで現在対象となっているシステムのパスを取得します。これは、ユーザーによる対話形式のチェック、または Simulink.ModelAdisor.getModelAdvisor のプログラムによるチェックのために最後に選択されたシステムまたはサブシステムのパスです。

参考

getModelAdvisor

getSelectedTask

目的

選択されたタスクを取得

構文

IDs = getSelectedTask

引数

IDs

現在選択されているタスク ID のセル配列。

説明

モデル アドバイザーで現在選択されているタスクの ID を返します。

参考

getSelectedCheck

getTaskAll

目的

モデル アドバイザーが実行したタスクを取得

構文

IDs = getTaskAll

引数

IDs

モデル アドバイザーが実行したタスクの ID のセル配列。

説明

モデル アドバイザーが実行したタスクの ID のセル配列を返します。

参考

getCheckAll, getGroupAll

Simulink.ModelAdvisor.openConfigUI

目的

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

構文

Simulink.ModelAdvisor.openConfigUI

説明

この静的メソッドは、モデル アドバイザーの設定エディターを起動します。モデル アドバイザーの設定エディターを使用して、モデル アドバイザーのためにカスタマイズされた設定を作成します。

    メモ:   モデル アドバイザーの設定エディターは、Simulink Verification and Validation (詳細は、「モデル アドバイザーの設定エディターを使用したチェックとフォルダーの整理」を参照) で使用できるオプションの機能です。

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

    • モデル アドバイザー設定エディターは、「コード生成フォルダー」内の slprj フォルダーを使用して、レポートやその他の情報を保存します。slprj フォルダーがコード生成フォルダーに存在しない場合、モデル アドバイザー設定エディターによって作成されます。詳細については、「モデル参照のシミュレーション ターゲット」を参照してください。

Simulink.ModelAdvisor.reportexists

目的

モデルまたはサブシステムに対して、レポートが存在するかどうかを判定

構文

exists = reportexists('system')

引数

system

システムまたはサブシステムのパスを指定する文字列。

exists

system のレポートが存在する場合は true (1)

説明

このメソッドは、MATLAB の作業フォルダーの slprj/modeladvisor サブフォルダーの system で指定されたモデル (システム) またはサブシステムに対して、レポート ファイルが存在する場合は true (1) を返します。

参考

exportReport

runCheck

目的

現在選択されたチェックを実行

構文

success = runCheck(ID)

引数

ID

実行するチェックの ID または ID のセル配列。

success

チェックが実行された場合は true (1)。

説明

モデル アドバイザーで現在選択されているチェックを実行します。このメソッドの実行は、モデル アドバイザー ウィンドウの [選択したチェックを実行] ボタンを選択することと同じです。

参考

selectCheck

runTask

目的

現在選択されたタスクを実行

構文

success = runTask

引数

success

チェックが実行された場合は true (1)。

説明

モデル アドバイザーで現在選択されているチェックを実行します。このメソッドの実行は、モデル アドバイザー ウィンドウの [選択したチェックを実行] ボタンを選択することと同じです。

参考

selectTask

selectCheck

目的

チェックを選択

構文

success = selectCheck(ID)

引数

ID

選択されたチェックの ID、または ID のセル配列。

success

このメソッドが指定したチェックを選択した場合は true (1)。

説明

ID が指定するチェックを選択します。このメソッドは、無効なチェックを選択できません。

参考

selectCheckAll, selectCheckForGroup, deselectCheck

selectCheckAll

目的

すべてのチェックを選択

構文

success = selectCheckAll

引数

success

すべてのチェックの選択にこのメソッドが成功した場合は true (1)。

説明

使用可能なすべてのチェックの選択を解除します。

参考

selectCheck, selectCheckForGroup, deselectCheck

selectCheckForGroup

目的

チェックのグループを選択

構文

success = selectCheckForGroup(ID)

引数

ID

ID、またはグループ ID のセル配列。

success

指定したグループの選択にこのメソッドが成功した場合は true (1)。

説明

ID が指定するグループを選択します。

参考

deselectCheckForGroup

selectCheckForTask

目的

指定したタスクまたはタスク セットのチェックを選択

構文

success = selectCheckForTask(ID)

引数

ID

チェックを選択するタスクの ID、または ID のセル配列。

success

指定したタスクのチェック選択にこのメソッドが成功した場合は true (1)。

説明

ID 引数で指定されたタスクのチェックを選択します。

参考

deselectCheckForTask

selectTask

目的

タスクを選択

構文

success = selectTask(ID)

引数

ID

選択されるタスクの ID、または ID のセル配列。

success

このメソッドが指定したタスクを選択した場合は true (1)。

説明

タスクを選択します。

参考

deselectTask

selectTaskAll

目的

すべてのタスクを選択

構文

success = selectTaskAll

引数

success

このメソッドがすべてのタスクを選択できた場合は true (1)。

説明

すべてのタスクを選択します。

参考

deselectTaskAll

setActionEnable

目的

チェック アクションのステータスを設定

構文

obj.setActionEnable(value)

引数

obj

Simulink.ModelAdvisor オブジェクトを表す変数。

value

アクション ボックスが有効か無効かを示す論理値。

  • true — アクション ボックスが有効。

  • false — アクション ボックスが無効。

説明

setActionEnable メソッドは、アクション ボックスを有効か無効に指定します。チェック コールバック関数のみがこのメソッドを呼び出せます。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックにアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

ModelAdvisor.Action

setBaselineMode

目的

モデル アドバイザーのベースライン データ生成モードを設定

構文

setBaselineMode(mode)

引数

mode

モデル アドバイザーのベースライン モードの設定を示す論理値。on (true) または off (false) です。

説明

モデル アドバイザーのベースライン モードを mode に設定します。ベースライン モードによって、モデル アドバイザーの検証メソッドはモデル アドバイザーの実行結果を確かめるために、ベースライン比較データを生成します。

参考

getBaselineMode, verifyCheckResult, verifyHTML

setCheckErrorSeverity

目的

チェックの失敗の重大度を設定

構文

obj.setCheckErrorSeverity(value)

引数

obj

Simulink.ModelAdvisor オブジェクトを表す変数。

value

失敗の重大度を示す整数。

  • 0 — チェック結果 = 警告

  • 1 — チェック結果 = 失敗

説明

現在実行中のチェックが失敗した場合の結果のステータスを value に設定します。チェック コールバック関数のみがこのメソッドを呼び出せます。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックにアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

setCheckResultStatus

setCheckResult

目的

現在実行しているチェックの結果を設定

構文

success = setCheckResult(result)

引数

result

現在実行中のタスク結果を指定する文字列またはセル配列。

success

チェック結果の設定に、このメソッドが成功した場合は true (1)。

説明

現在実行中のチェック結果を設定します。チェックのコールバック関数のみがこのメソッドを呼び出せます。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックで使用するためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

getCheckResult, setCheckResultData, setCheckResultStatus

setCheckResultData

目的

現在実行しているチェックの結果のデータを設定

構文

success = setCheckResultData(data)

引数

data

設定される結果のデータ。

success

現在のチェック結果のデータ設定に成功した場合は true (1)。

説明

現在実行しているチェックに対してチェック結果のデータを設定します。チェックのコールバック関数のみがこのメソッドを呼び出せます。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックで使用するためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

getCheckResultData, setCheckResult, setCheckResultStatus

setCheckResultStatus

目的

現在実行しているチェックのステータスを設定

構文

success = setCheckResultStatus(status)

引数

status

実行直後のチェック ステータスが成功 (true) または失敗 (false) であるかを示す論理値。

success

ステータスが設定された場合は true (1)。

説明

現在実行中のチェックの成功/失敗ステータスを status に設定します。チェックのコールバック関数のみがこのメソッドを呼び出せます。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックで使用するためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

getCheckResultStatus, setCheckResult, setCheckResultData, setCheckErrorSeverity

setListViewParameters

目的

チェックのリスト表示パラメーターを指定

構文

obj.setListViewParameters(check_ID, params)

引数

obj

Simulink.ModelAdvisor オブジェクトを表す変数。

check_ID

チェックを一意に識別する文字列。

チェックのコールバック関数内のメソッドを使用する場合、check_ID を省略できます。

params

ModelAdvisor.ListViewParameter オブジェクトのセル配列。

説明

チェックのリスト表示パラメーターを設定します。

    メモ:   このメソッドは、モデル アドバイザーのカスタマイゼーション API (Simulink Verification and Validation ソフトウェアのオプションの機能) で作成されたカスタム チェックにアクセスするためのものです。詳細は、Simulink Verification and Validation ドキュメンテーションの「カスタム チェックの定義」を参照してください。

参考

getListViewParameters, ModelAdvisor.ListViewParameter

verifyCheckRan

目的

モデル アドバイザーがチェック セットを実行したことを確認

構文

[success, missingChecks, additionalChecks] = verifyCheckRan(IDs)

引数

IDs

確認するチェック ID のセル配列。

success

チェックが実行されたかどうかを示す論理値。

missingChecks

指定したが実行されなかったチェックの ID のセル配列。

additionalChecks

実行するように指定しなかったチェック ID のセル配列。

説明

出力変数 successtrue を返すのは、次の両方に該当する場合です。

  • IDs で指定したすべてのチェックが実行された場合。

  • IDs で指定したチェックのみが実行された場合。

missingChecks 引数は、指定したが実行されなかったチェックを提供します。additionalChecks 引数は、実行した未指定のチェックをリストします。

参考

verifyCheckResultStatus

verifyCheckResult

目的

ベースライン モデル アドバイザー チェック結果のファイルを作成、または現在のチェック結果をベースライン チェックの結果と比較

構文

[success message] = verifyCheckResult(baseline, checkIDs)

引数

baseline

ベースライン チェック結果の MAT ファイルのパス。

checkIDs

チェック ID のセル配列。

success

メソッドが成功/失敗したかどうかを示す論理値。

message

エラー メッセージを指定する文字列。

説明

モデル アドバイザーがベースライン モード (setBaselineModeを参照) の場合、このメソッドは baseline で指定された位置に、MAT ファイルの checkIDs で指定されたチェックの実行の最新結果を保存します。指定した位置にチェックの結果を保存できない場合、このメソッドは、出力変数 successfalse を返し、出力変数 message に失敗の原因を返します。モデル アドバイザーがベースライン モードにない場合、このメソッドは、checkIDs で指定したチェックの実行の最新結果を baseline で指定したレポートと比較します。現在の結果がベースラインの結果に一致する場合、このメソッドは出力変数 success の値に true を返します。

    メモ:   verifyCheckResult を実行する前に、checkIDs (runCheckを参照) で指定したチェックを実行してください。

このメソッドによって、モデル アドバイザーが生成した最新のチェック結果を、チェック結果のベースライン セットと比較できます。このメソッドを使用すると、現在の結果とベースライン結果の比較の実行と同様に、ベースライン レポートを生成できます。ベースライン レポートを生成するには、setBaselineMode を使用してモデル アドバイザーをベースライン モードにします。その後、ベースラインの結果を保存する位置に、ベースライン引数を設定してこのメソッドを実行します。現在のレポートとベースライン レポートの比較を行う際には、まずモデル アドバイザーがベースライン モードでないことを確認します (getBaselineModeを参照)。次に baseline 入力引数の値としてベースライン レポートのパスとこのメソッドを呼び出します。

参考

setBaselineMode, getBaselineMode, runCheck, verifyCheckResultStatus

verifyCheckResultStatus

目的

モデルがチェック セットに成功/失敗したかを確認

構文

[success message] = verifyCheckResultStatus(baseline, checkIDs)

引数

baseline

Boolean 変数の配列。

checkIDs

チェック ID のセル配列。

success

メソッドが成功/失敗したかどうかを示す論理値。

message

エラー メッセージを指定する文字列。

説明

このメソッドは、checkIDs で指定されたチェックの最後の実行の成功/失敗 (true/false) のステータスを baseline で指定した論理値と比較します。ステータスがベースラインに一致する場合、このメソッドは出力変数 success の値として true を返します。

    メモ:   verifyCheckResultStatus を呼び出す前に、checkIDs (runCheckを参照) で指定したチェックを実行してください。

参考

runCheck

verifyHTML

目的

ベースライン モデル アドバイザー レポートを生成するか、現在のレポートをベースライン レポートと比較

構文

[success message] = verifyHTML(baseline)

引数

baseline

モデル アドバイザー レポートのパス。

success

メソッドが成功/失敗したかどうかを示す論理値。

message

エラー メッセージを指定する文字列。

説明

モデル アドバイザーがベースライン モード (setBaselineModeを参照) である場合、このメソッドはモデル アドバイザーで最後に生成されたレポートを baseline で指定された位置に保存します。指定した位置でメソッドがレポートのコピーを保存できない場合、出力変数 successfalse を返し、出力変数 message に失敗の原因を返します。モデル アドバイザーがベースライン モードにない場合、このメソッドはモデル アドバイザーで最後に生成されたレポートを baseline で指定されたレポートと比較します。現在のレポートがベースライン レポートと同じ内容の場合、このメソッドは、success 出力変数の値として true を返します。

このメソッドを使うと、モデル アドバイザーが生成したレポートをベースライン レポートと比較し、それらが異なるかどうか判定できます。このメソッドを使用して、現在のレポートとベースライン レポートの比較の実行と同様に、ベースライン レポートを生成できます。ベースライン レポートを生成するには、モデル アドバイザーをベースライン モードにします。その後、ベースライン レポートを保存する位置にベースライン引数を設定して、このメソッドを呼び出します。現在のレポートとベースライン レポートの比較を行う際には、まずモデル アドバイザーがベースライン モードでないことを確認します (getBaselineModeを参照)。次に baseline 入力引数の値としてベースライン レポートのパスとこのメソッドを呼び出します。

参考

setBaselineMode, getBaselineMode, verifyCheckResult

R2006a で導入

この情報は役に立ちましたか?