Main Content

select

Include check and folder instances in Model Advisor analysis

Since R2024b

collapse all in page

Syntax

select(CfgObj,CheckInstanceID)
select(CfgObj,FolderInstanceID)

Description

select(CfgObj,CheckInstanceID) selects the check instance CheckInstanceID in the configuration accessed by the CfgObj object. The selected check instances are included to the Model Advisor analysis.

example

select(CfgObj,FolderInstanceID) includes the folder instance FolderInstanceID and the checks in it to the Model Advisor analysis.

Examples

collapse all

Consider an existing configuration file myCustomFile.json is located in your working directory. This example shows how to include check instances in the Model Advisor analysis.

Create a Model Advisor configuration object.

CfgObj = Advisor.Config;

Load the existing configuration file myCustomFile.json.

loadConfig(CfgObj,'myCustomFile.json');

Create a new folder named My Folder under the root node.

addFolder(CfgObj,'_SYSTEM','My Folder');

Add the checks with the IDs mathworks.jmaab.jc_0231 and mathworks.jmaab.jc_0222 under My Folder.

addCheck(CfgObj,'_SYSTEM_My Folder','mathworks.jmaab.jc_0231');
addCheck(CfgObj,'_SYSTEM_My Folder','mathworks.jmaab.jc_0222');

Include the folder My Folder and the checks in it to the Model Advisor analysis.

select(CfgObj,'_SYSTEM_My Folder');

Input Arguments

collapse all

Model Advisor configuration object, specified as an Advisor.Config object.

By default, after creation, the object provides you access to an editable blank configuration that you can use to create a new custom configuration. To customize an existing configuration, load the configuration JSON file as the active configuration by using loadConfig.

Check instance ID, specified as a character vector or string scalar. The instance ID represents the location of the check in the configuration in this form _SYSTEM_Check Hierarchy_Check ID.

Example: '_SYSTEM_By Product_mathworks.jmaab.ar_0001'

Folder instance ID, specified as a character vector or string scalar. The instance ID represents the location of the folder in the configuration in this form _SYSTEM_Folder Hierarchy.

Example: '_SYSTEM_By Product'

Alternative Functionality

App

You can also use the Model Advisor Configuration Editor to modify existing configurations and create new configurations. In the Model Advisor Configuration Editor, to include a check or folder to the Model Advisor analysis, select the corresponding check box. For more information, see Use Model Advisor Configuration Editor to Customize Model Advisor.

Version History

Introduced in R2024b

See Also

|

Topics