ModelAdvisor.Check

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

説明

ModelAdvisor.Check クラスは、モデル アドバイザー チェックを作成します。

作成

構文

check_obj = ModelAdvisor.Check(check_ID)

説明

check_obj = ModelAdvisor.Check(check_ID) はチェック オブジェクト check_obj を作成し、それを一意の識別子 check_ID に割り当てます。モデル アドバイザー ツリーにチェックを表示するには、チェックが ModelAdvisor.Task または ModelAdvisor.Root オブジェクトと関連付けられている必要があります。

1 つの ModelAdvisor.Check オブジェクトを複数の ModelAdvisor.Task オブジェクトで使用できるため、モデル アドバイザー ツリーの複数の場所に同一のチェックを配置できます。たとえば、[暗黙的な信号の関連付けをチェック] は、モデル アドバイザー ツリーの [製品別] 、 [Simulink] フォルダーと、[タスク別] 、 [モデル参照] フォルダーに表示されます。

チェックをタスク定義に使用するときは、次のルールが適用されます。

• チェック定義関数とタスク定義関数でチェックのプロパティを定義する場合、モデル アドバイザーは、タスク定義に含まれている情報のみを表示します。たとえば、ModelAdvisor.Task.DisplayName プロパティと ModelAdvisor.Check.Title プロパティを使用してチェック名を定義する場合、モデル アドバイザーは、ModelAdvisor.Task.DisplayName に与えられている情報を表示します。

• チェック定義でチェックのプロパティを定義し、タスク定義では定義しない場合、タスクはチェック定義のプロパティを使用します。たとえば、ModelAdvisor.Check.Title プロパティを使用して、チェック定義関数でチェック名を定義し、タスク定義を使用してチェックを登録する場合、モデル アドバイザーは、ModelAdvisor.Check.Title に与えられている情報を表示します。

• タスク定義関数でチェックのプロパティを定義し、チェック定義関数では定義しない場合、タスクをチェック定義ではなく、モデル アドバイザーで登録する場合にかぎり、モデル アドバイザーはその情報を表示します。たとえば、ModelAdvisor.Check.Title プロパティではなく、ModelAdvisor.Task.DisplayName プロパティを使用することで、タスク定義でチェック名を定義し、タスク定義を使用してチェックを登録する場合、モデル アドバイザーは、ModelAdvisor.Task.DisplayName に与えられている情報を表示します。

入力引数

check_ID — カスタム モデル アドバイザー チェックのチェック ID。文字ベクトルとして指定します。

文字ベクトル

カスタム モデル アドバイザー チェックの一意の識別子。

プロパティ

CallbackContext	Specify when to run check
CallbackHandle	Callback function handle for check
CallbackStyle	Callback function type
EmitInputParametersToReport	Display check input parameters in the Model Advisor report
Enable	Indicate whether user can enable or disable check
ErrorSeverity	Set severity of check failure
ID	Identifier for check
LicenseName	Product license names required to display and run check
Result	Results cell array
ResultDetails	Result details in a cell array
SupportExclusion	Set to support exclusions
SupportLibrary	Set to support library models
Title	Name of check
TitleTips	Description of check
Value	Status of check
Visible	Indicate to display or hide check

オブジェクト関数

getID	チェック識別子を返す
setAction	チェックのアクションの指定
setHelp	Set custom help for custom authored Model Advisor checks
setCallbackFcn	チェックのコールバック関数の指定
setInputParameters	チェックの入力パラメーターの指定
setInputParametersLayoutGrid	入力パラメーターのレイアウト グリッドを指定する
setResultDetails	結果の詳細をチェック オブジェクトに関連付ける

バージョン履歴

R2008a で導入

参考

トピック

• カスタム モデル アドバイザー チェックの定義
• モデル アドバイザーの概要の構成のカスタマイズ
• モデル アドバイザー カスタム構成の作成と展開