Main Content

Create Model Advisor Checks

Define custom checks and provide a fix action

You can use the Model Advisor API to create Model Advisor checks. Custom checks provide you with the ability to specify which conditions and configuration settings the Model Advisor reviews. For the workflow, see Define Your Own Custom Model Advisor Checks.

Classes

expand all

Advisor.authoring.CustomCheckDefine custom configuration parameter check
Advisor.authoring.DataFileInteract with data file for model configuration checks
ModelAdvisor.ActionAdd actions to custom checks
ModelAdvisor.CheckCreate custom checks
ModelAdvisor.PreferencesSet Model Advisor window preferences by specifying which folders and tabs to display
ModelAdvisor.InputParameterAdd input parameters to custom checks
ModelAdvisor.ListViewParameterAdd list view parameters to custom checks
ModelAdvisor.RootIdentify root node
ModelAdvisor.FormatTemplateTemplate for formatting Model Advisor analysis results
ModelAdvisor.ImageInclude image in Model Advisor output
ModelAdvisor.LineBreakInsert line break
ModelAdvisor.ListCreate list class
ModelAdvisor.ParagraphCreate and format paragraph
ModelAdvisor.TableCreate table for Model Advisor results
ModelAdvisor.TextCreate Model Advisor text output
ModelAdvisor.ResultDetailDefines result detail objects
Advisor.authoring.PositiveBlockParameterConstraintCreate a Model Advisor constraint to check for supported block parameter values
Advisor.authoring.NegativeBlockParameterConstraintCreate a Model Advisor constraint to check for unsupported block parameter values
Advisor.authoring.PositiveModelParameterConstraintCreate a Model Advisor constraint to check for supported model parameter values
Advisor.authoring.NegativeModelParameterConstraintCreate a Model Advisor constraint to check for unsupported model parameter values
Advisor.authoring.PositiveBlockTypeConstraintCreate a Model Advisor constraint to check for supported block types
Advisor.authoring.NegativeBlockTypeConstraintCreate a Model Advisor constraint to check for unsupported blocks
Advisor.authoring.CompositeConstraintCreate a Model Advisor constraint that checks for multiple constraints

Functions

expand all

Advisor.authoring.generateConfigurationParameterDataFileGenerate XML data file for custom configuration parameter check
Advisor.authoring.generateBlockConstraintsDataFileGenerate XML data file for custom check for block constraints
Advisor.authoring.createBlockConstraintCheckCreate Model Advisor check for registering block constraints
addPreRequisiteConstraintIDCheck a prerequisite constraint object before the actual constraint object

Topics

Define Your Own Custom Model Advisor Checks

Create a custom check that specifies a set of conditions and model configuration settings that the Model Advisor reviews.

Review a Model Against Conditions that You Specify With the Model Advisor

Create a simple pass/fail check with no fix action and an informational check.

Fix a Model to Comply with Conditions that You Specify With the Model Advisor

Create a pass/fail check that groups results by block or subsystem and provides a fix action.

Create Model Advisor Check for Model Configuration Parameters

To verify the configuration parameters for your model, create a configuration parameter check.

Define the Compile Option for Custom Model Advisor Checks

To use Model Advisor custom checks to evaluate generated code, specify the compile option for each check.

Exclude Blocks From Custom Checks

This example shows how to exclude blocks from custom checks.

Define Model Advisor Checks for Supported or Unsupported Blocks and Parameters

Create Model Advisor checks that specify block and model parameter constraints.