Main Content

ModelAdvisor.Check

Create custom Model Advisor checks

expand all in page

Description

The ModelAdvisor.Check class creates Model Advisor checks.

Creation

Syntax

check_obj = ModelAdvisor.Check(check_ID)

Description

check_obj = ModelAdvisor.Check(check_ID) creates a check object, 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.

Input Arguments

expand all

Unique identifier for the custom Model Advisor check.

Properties

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

Object Functions

getIDReturn check identifier
setActionSpecify action for check
setHelpSet custom help for custom authored Model Advisor checks
setCallbackFcnSpecify callback function for check
setInputParametersSpecify input parameters for check
setInputParametersLayoutGridSpecify layout grid for input parameters
setResultDetailsAssociates result details with a check object

Version History

Introduced in R2008a

See Also

Topics