Main Content

ModelAdvisor.Check

创建自定义模型顾问检查

说明

ModelAdvisor.Check 类创建模型顾问检查。

创建对象

描述

check_obj = ModelAdvisor.Check(check_ID) 创建一个检查对象 check_obj,并为其分配唯一标识符 check_ID。要在模型顾问树中显示检查,检查必须具有关联的 ModelAdvisor.TaskModelAdvisor.Root 对象。

您可以在多个 ModelAdvisor.Task 对象中使用同一个 ModelAdvisor.Check 对象,从而允许您在模型顾问树的多个位置放置相同的检查。例如,检查隐藏信号解析显示在模型顾问树中的按产品 > Simulink 文件夹中和按任务 > 模型引用文件夹中。

当您在任务定义中使用检查时,以下规则适用:

  • 如果在检查定义函数和任务定义函数中均定义了检查的属性,则模型顾问仅显示任务定义中包含的信息。例如,如果使用 ModelAdvisor.Task.DisplayName 属性和 ModelAdvisor.Check.Title 属性定义检查的名称,模型顾问将显示 ModelAdvisor.Task.DisplayName 中提供的信息。

  • 如果在检查定义中定义了检查的属性,但没有在任务定义中定义,则任务将使用来自检查的属性。例如,如果使用 ModelAdvisor.Check.Title 属性在检查定义函数中定义检查的名称,并使用任务定义注册该检查,则模型顾问将显示 ModelAdvisor.Check.Title 中提供的信息。

  • 如果您在任务定义函数中定义检查的属性,但没有在检查定义函数中定义,则只要您向模型顾问注册的是任务而不是检查,模型顾问就会显示信息。例如,如果使用 ModelAdvisor.Task.DisplayName 属性而不是 ModelAdvisor.Check.Title 属性在任务定义中定义检查的名称,并且使用任务定义注册该检查,则模型顾问将显示 ModelAdvisor.Task.DisplayName 中提供的信息。

输入参数

全部展开

自定义模型顾问检查的唯一标识符。

属性

CallbackContextSpecify when to run check
CallbackHandleCallback function handle for check
CallbackStyleCallback function type
EmitInputParametersToReportDisplay check input parameters in the Model Advisor report
EnableIndicate whether user can enable or disable check
ErrorSeveritySet severity of check failure
IDIdentifier for check
LicenseNameProduct license names required to display and run check
ResultResults cell array
ResultDetailsResult details in a cell array
SupportExclusionSet to support exclusions
SupportLibrarySet to support library models
TitleName of check
TitleTipsDescription of check
ValueStatus of check
VisibleIndicate to display or hide check

对象函数

getID返回检查标识符
setAction指定检查的操作
setHelpSet custom help for custom authored Model Advisor checks
setCallbackFcnSpecify callback function for check
setInputParameters指定检查的输入参数
setInputParametersLayoutGridSpecify layout grid for input parameters
setResultDetailsAssociates result details with a check object

版本历史记录

在 R2008a 中推出