Create custom checks
The ModelAdvisor.Check
class creates Model Advisor
checks.
check_obj = ModelAdvisor.Check(
creates a check object, check_ID
)check_obj
, and
assigns it a unique identifier, check_ID
.
To display checks in the Model Advisor tree, the checks must
have an associated ModelAdvisor.Task
or ModelAdvisor.Root
object.
You can use one ModelAdvisor.Check
object
in multiple ModelAdvisor.Task
objects,
allowing you to place the same check in multiple locations
in the Model Advisor tree. For example, Check for
implicit signal resolution is displayed
in the By Product > Simulink folder and in the By Task > Model Referencing folder in the Model Advisor tree.
When you use checks in task definitions, the following rules apply:
If you define the properties of the check in
the check definition and the task definition
functions, the Model Advisor only displays the
information contained in the task definition. For
example, if you define the name of the check using
the ModelAdvisor.Task.DisplayName
property
and using the ModelAdvisor.Check.Title
property, the
Model Advisor displays the information provided in
ModelAdvisor.Task.DisplayName
.
If you define the properties of the check in
the check definition but not the task definition,
the task uses the properties from the check. For
example, if you define the name of the check in
the check definition function using the ModelAdvisor.Check.Title
property, and you register the check using a task
definition, the Model Advisor displays the
information provided in ModelAdvisor.Check.Title
.
If you define the properties of the check in
the task definition function but not the check
definition function, the Model Advisor displays
the information as long as you register the task
with the Model Advisor instead of the check. For
example, if you define the name of the check in
the task definition using the ModelAdvisor.Task.DisplayName
property
instead of the ModelAdvisor.Check.Title
property, and
you register the check using a task definition,
the Model Advisor displays the information
provided in ModelAdvisor.Task.DisplayName
.
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 |
ListViewVisible | Status of Explore Result button |
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 | Return check identifier |
setAction | Specify action for check |
setCallbackFcn | Specify callback function for check |
setInputParameters | Specify input parameters for check |
setInputParametersLayoutGrid | Specify layout grid for input parameters |
setResultDetails | Associates result details with a check object |