Main Content

ModelAdvisor.run

Use Model Advisor to run checks on systems

    Description

    example

    ModelAdvisor.run(Systems,CheckIDList) runs the Model Advisor on the models or subsystems specified by Systems for the list of check IDs specified by CheckIDList.

    example

    ModelAdvisor.run(Systems,'Configuration',FileName) runs the Model Advisor for the list of checks specified by the Model Advisor configuration file FileName.

    example

    ModelAdvisor.run(Systems,{{CheckID,'InputParam',{paramName,paramValue}}}) runs the Model Advisor for the check ID specified by CheckID with the input parameter setting specified by the input parameter name paramName and the input parameter value paramValue.

    example

    ModelAdvisor.run(Systems,{{CheckID1,'InputParam',{paramName1,paramValue1,...,paramNameN,paramValueN}},...,{CheckIDN,'InputParam',{paramName1,paramValue1,...,paramNameN,paramValueN}}}) runs the Model Advisor for one or more check IDs with the input parameter settings specified using 'InputParam'.

    The check IDs are specified by CheckID1 through CheckIDN. For each check ID, you can specify the input parameters for the check by using 'InputParam' with the parameter names, paramName1 through paramNameN, and parameter values, paramValue1 through paramValueN.

    For example, the following code runs the Model Advisor checks:

    • 'mathworks.jmaab.jc_0281' with the input parameter 'Follow links' set to 'off' and the 'jc_0281_a' sub-checks disabled

    • 'mathworks.jmaab.db_0032' with the input parameter 'Follow links' set to 'off' and the input parameter 'Look under masks' set to 'all'

    Results = ModelAdvisor.run('vdp',...
    {{'mathworks.jmaab.jc_0281','InputParam',{'Follow links','off','jc_0281_a',0}},...
    {'mathworks.jmaab.db_0032','InputParam',{'Follow links','off','Look under masks','all'}}})

    example

    Results = ModelAdvisor.run(___,Name,Value) specifies the properties of the Model Advisor analysis using one or more Name,Value pair arguments and returns the results in Results. Use Results to view the properties of the Model Advisor run. Use this option with one of the previous syntaxes.

    Examples

    collapse all

    Create a list of check IDs and use ModelAdvisor.run to run the checks on the specified subsystems.

    Create a list of the check IDs for the checks Check model diagnostic parameters and Check for unconnected objects.

    checkIDs = {'mathworks.maab.jc_0021',...
    'mathworks.iec61508.UnconnectedObjects'};
    

    Open the example model sldemo_auto_climatecontrol.

    openExample('sldemo_auto_climatecontrol')

    Create a list of the subsystems sldemo_auto_climatecontrol/Heater Control and sldemo_auto_climatecontrol/AC Control.

    systems = {'sldemo_auto_climatecontrol/Heater Control',...
        'sldemo_auto_climatecontrol/AC Control'};
    

    Use Model Advisor to run the checks on the subsystems.

    results = ModelAdvisor.run(systems,checkIDs);

    For more information on Model Advisor checks, see Model Advisor Checks Documentation. For details on how to find check IDs, see Find Model Advisor Check IDs.

    Create a list of checks that specify the input parameter values, then use the Model Advisor to run the checks.

    Open the model vdp.

    open_system('vdp')

    Create a list of the input parameters used by the checks Check signal line connections and Check trigger signal names.

    To find the input parameters for the checks, create a Model Advisor object for the model and use getInputParameters. The check ID for the check Check signal line connections is 'mathworks.jmaab.db_0032' and the check ID for the check Check trigger signal names is 'mathworks.jmaab.jc_0281'.

    ma = Simulink.ModelAdvisor.getModelAdvisor('vdp');
    
    db_0032_parameters = getInputParameters(ma, 'mathworks.jmaab.db_0032');
    jc_0281_parameters = getInputParameters(ma, 'mathworks.jmaab.jc_0281');

    For the check 'mathworks.jmaab.db_0032', db_0032_parameters{6} contains the InputParameter properties for the input parameter Follow links. Save the input parameter name to the variable followLinks.

    followLinks = db_0032_parameters{6}.Name;

    For 'mathworks.jmaab.db_0032', set the input parameter Follow links to 'off'. When Follow links is 'off', the Model Advisor does not analyze the content of library-linked blocks.

    check1 = {'mathworks.jmaab.db_0032',...
    'InputParam',{followLinks,'off'}};

    For the check 'mathworks.jmaab.jc_0281', jc_0281_parameters{1} contains the InputParameter properties for the input parameter jc_0281_a and jc_0281_parameters{2} contains the InputParameter properties for the input parameter jc_0281_b. jc_0281_a and jc_0281_b contain sub-checks for 'mathworks.jmaab.jc_0281'. Save the input parameter names to the variables subCheckA and subCheckB.

    subCheckA = jc_0281_parameters{1}.Name;
    subCheckB = jc_0281_parameters{2}.Name;

    Select the sub-check 'jc_0281_a2' and disable the 'jc_0281_b' sub-checks. The input parameter value 2 selects the second sub-check of 'jc_0281_a'. The input parameter value 0 disables 'jc_0281_b' sub-checks. For more information on 'mathworks.jmaab.jc_0281' and its sub-checks, see Check trigger signal names.

    check2 = {'mathworks.jmaab.jc_0281',...
    'InputParam',{subCheckA, 2, subCheckB, 0}};

    Create the list of checks.

    listOfChecks = {check1, check2};

    Use Model Advisor to run the specified checks on the system vdp.

    results = ModelAdvisor.run('vdp', listOfChecks)

    For more information on Model Advisor checks and sub-checks, see Model Advisor Checks Documentation. For details on how to find check IDs, see Find Model Advisor Check IDs.

    Run the Model Advisor on a list of checks specified by a Model Advisor configuration file.

    Open the example model sldemo_auto_climatecontrol.

    openExample('sldemo_auto_climatecontrol')

    Copy the example script prepare_cust_chk_code.m to the current folder and run the script. The script copies files for this example to the current folder.

    copyfile(fullfile(matlabroot,'examples','slcheck','main',...
        'prepare_cust_chk_code.m'),'prepare_cust_chk_code.m','f');
    
    run('prepare_cust_chk_code.m');

    Refresh the Model Advisor check information cache to include the files for this example.

    Advisor.Manager.refresh_customizations()
    

    Use the example configuration file demoConfiguration.json to specify which checks to include in the Model Advisor analysis. Save the file name demoConfiguration.json to the variable fileName.

    fileName = 'demoConfiguration.json';
    

    Create a list of the subsystems sldemo_auto_climatecontrol/Heater Control and sldemo_auto_climatecontrol/AC Control.

    systems = {'sldemo_auto_climatecontrol/Heater Control',...
        'sldemo_auto_climatecontrol/AC Control'};
    

    Use the Model Advisor to run the checks specified by the configuration file demoConfiguration.json on the subsystems specified by systems.

    results = ModelAdvisor.run(systems,'Configuration',fileName);

    For information on Model Advisor checks and sub-checks, use the links to the product-specific check documentation in Model Advisor Checks Documentation. For details on how to find check IDs, see Find Model Advisor Check IDs.

    Use the Model Advisor to run the checks and generate a report.

    Open the model vdp.

    open_system('vdp')

    Create a list of check IDs. The check ID for the check Check signal line connections is 'mathworks.jmaab.db_0032' and the check ID for the check Check trigger signal names is 'mathworks.jmaab.jc_0281'.

    checkIDs = {'mathworks.jmaab.db_0032','mathworks.jmaab.jc_0281'}

    Use Model Advisor to run the checks on the model. Use the name-value arguments 'ReportFormat', 'ReportPath', and 'ReportName' to generate a Model Advisor Report in the current folder, pwd, and in the format of a Microsoft® Word document.

    ModelAdvisor.run('vdp', checkIDs,...
    'ReportFormat', 'docx', 'ReportPath', pwd, 'ReportName', 'myReport')

    For more information on Model Advisor checks and sub-checks, see Model Advisor Checks Documentation. For details on how to find check IDs, see Find Model Advisor Check IDs.

    Input Arguments

    collapse all

    List of models or subsystems, specified as a cell array of model names or subsystem names.

    Example: {'vdp', 'sldemo_2counters'}

    Example: {'sldemo_auto_climatecontrol/Heater Control', 'sldemo_auto_climatecontrol/AC Control'}

    Unique identifiers for the Model Advisor checks, specified as a character vector, or cell array of character vectors.

    For information on how to find check IDs, see Find Model Advisor Check IDs.

    Do not include duplicate check IDs in CheckIDList. If you need to run the same check multiple times, but with different input parameters, use either of the following approaches:

    • Call ModelAdvisor.run separately for each different input parameter.

      For example, to run the check 'mathworks.jmaab.jc_0281' two times, one time with the sub-check 'jc_0281_a' disabled and one time with the sub-check 'jc_0281_a2' selected:

      myCheck = 'mathworks.jmaab.jc_0281';
      inputParam1 = {'jc_0281_a',0}; % disable 'jc_0281_a' sub-checks
      inputParam2 = {'jc_0281_a',2}; % select sub-check 'jc_0281_a2'
      
      ModelAdvisor.run(modelName,{{myCheck,'InputParam',inputParam1}})
      ModelAdvisor.run(modelName,{{myCheck,'InputParam',inputParam2}})
      

    • Create and run a Model Advisor configuration that uses separate check instances for each different input parameter. In the Model Advisor Configuration Editor, create a new folder for each different input parameter that you want to run, copy the check into each folder, and modify the checks in each folder to specify different input parameters. Use the ModelAdvisor.run(Systems,'Configuration',FileName) syntax to run the configuration.

    Example: 'mathworks.jmaab.jc_0281'

    Example: {'mathworks.maab.jc_0021', 'mathworks.misra.BlockNames'}

    Unique identifier for the Model Advisor check, specified as a character vector.

    For information on how to find check IDs, see Find Model Advisor Check IDs.

    Example: 'mathworks.jmaab.jc_0281'

    The name of an input parameter, specified as a character vector.

    You can view the input parameter names for a Model Advisor check by using getInputParameters on a Simulink.ModelAdvisor object. The input parameter name, Name, is a property of the ModelAdvisor.InputParameter object. For more information, see Use the Model Advisor to Run Sub-Checks.

    The input parameters for a check can also be viewed in the Model Advisor Configuration Editor. Input parameter values can be saved to your custom Model Advisor configuration file. For more information, see Use the Model Advisor Configuration Editor to Customize the Model Advisor.

    For more information on Model Advisor checks, sub-checks and input parameters, use the links to product-specific check documentation in Model Advisor Checks Documentation.

    Example: 'Follow links'

    Example: 'jc_0281_a'

    The value of an input parameter, specified as a character vector or integer.

    You can view the input parameter values for a Model Advisor check by using getInputParameters on a Simulink.ModelAdvisor object. The current input parameter value, Value, is a property of the ModelAdvisor.InputParameter object. For more information, see Use the Model Advisor to Run Sub-Checks.

    The input parameters for a check can also be viewed in the Model Advisor Configuration Editor. Input parameter values can be saved to your custom Model Advisor configuration file. For more information, see Use the Model Advisor Configuration Editor to Customize the Model Advisor.

    For more information on Model Advisor checks, sub-checks and input parameters, use the links to product-specific check documentation in Model Advisor Checks Documentation.

    Example: 'off'

    Example: 4

    Name of the Model Advisor configuration file, specified as a character vector. For details on creating a configuration file, see Use the Model Advisor Configuration Editor to Customize the Model Advisor.

    Example: 'demoConfiguration.json'

    Name-Value Arguments

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

    Example: 'ExtensiveAnalysis','Off'

    Report display setting for the Model Advisor, specified as 'Summary', 'Details', or 'None'. Setting DisplayResults to 'Summary' displays a summary of the system results in the Command Window. Setting DisplayResults to 'Details' displays:

    • Which system the Model Advisor is checking while the run is in progress

    • The pass and fail results of each check for each system

    • A summary of the system results

    Setting DisplayResults to 'None' displays no information in the Command Window.

    Example: 'Details'

    Extensive analysis setting for the Model Advisor, specified as 'On' or 'Off'. Setting 'ExtensiveAnalysis' to 'On' runs each of the checks in your Model Advisor configuration, including checks that trigger extensive analysis. Setting 'ExtensiveAnalysis' to 'Off' runs only checks that do not trigger extensive analysis.

    Checks that trigger extensive analysis of the model use additional analysis techniques, such as analysis with Simulink® Design Verifier™. The checks that trigger extensive analysis have the icon Extensive Analysis icon in front of the check name in the Model Advisor.

    To use the 'ExtensiveAnalysis' name-value argument, you must specify a check configuration file name with the 'Configuration' argument.

    Example: 'Off'

    Force delete setting for the Model Advisor, specified as 'Off' or 'On'. Setting Force to 'On' removes existing modeladvisor/system folders. Setting Force to 'Off' prompts you before removing existing modeladvisor/system folders.

    Example: 'On'

    Parallel execution setting for the Model Advisor, specified as 'Off' or 'On'. Setting ParallelMode to 'On' runs the Model Advisor in parallel mode if you have a Parallel Computing Toolbox™ license and a multicore machine. Parallel Computing Toolbox does not support 32-bit Windows® machines. Each parallel process runs checks on one model at a time. In parallel mode, load the model data from the model workspace or data dictionary. In parallel mode, the Model Advisor does not support model data in the base workspace. For an example, see Create a Function to Check Multiple Systems.

    Example: 'On'

    Temporary working folder setting for the Model Advisor, specified as 'Off' or 'On'. Setting TempDir to 'On' runs the Model Advisor from a temporary working folder to avoid concurrency issues when running using a parallel pool. For more information, see Resolving Data Concurrency Issues. Setting TempDir to 'Off' runs the Model Advisor in the current working folder.

    Example: 'On'

    Exclusion display setting for the report, specified as 'On' or 'Off'. Setting ShowExclusions to 'On' lists Model Advisor check exclusions in the report. Setting ShowExclusions to 'Off' does not list Model Advisor check exclusion in the report.

    Example: 'Off'

    Format of the generated report, specified as HTML format, PDF format, or Microsoft Word document format.

    Note

    Model Advisor displays an error if unsupported formats are selected. For the Windows operating system, the supported formats are 'html', 'pdf', and 'docx'. For UNIX® like operating systems, the only supported format is 'html'.

    Example: 'docx'

    Folder for the generated report, specified as a character vector. By default, 'ReportPath' is the 'slprj/modeladvisor/modelName' folder in the current working directory.

    Example: 'C:\MyProject\MyReports'

    Prefix for the Model Advisor report file name, specified as a character vector. An underscore and the model name, '_modelName', are appended to the report file name. For example, if you run the Model Advisor on the model vdp with the ReportName 'MyReport', the Model Advisor report has the file name 'MyReport_vdp'.

    Example: 'MyReport'

    Output Arguments

    collapse all

    Model Advisor check results, specified as a cell array of ModelAdvisor.SystemResult objects. The function returns one object for each model or subsystem specified by the input argument Systems.

    Each ModelAdvisor.SystemResult object contains a CheckResultObjs property that contains an array of ModelAdvisor.CheckResult objects, one for each check run by ModelAdvisor.run.

    To review the results without having to rerun the Model Advisor, save the results. For more information, see Save and Load Process for Objects.

    Tips

    • If you have a Parallel Computing Toolbox license and a multicore machine, Model Advisor can run on multiple systems in parallel. You can run the Model Advisor in parallel mode by using ModelAdvisor.run with 'ParallelMode' set to 'On'. By default, 'ParallelMode' is set to 'Off'. When you use ModelAdvisor.run with 'ParallelMode' set to 'On', MATLAB® automatically creates a parallel pool.

    Alternatives

    • Use the Model Advisor user interface to run each system. In the user interface, you can run only one system at a time.

    • Create a script or function by using a Simulink.ModelAdvisor object to run each system, one at a time.

    Extended Capabilities