resetMetricFamilyParameterValues

Class: slmetric.config.Configuration
Namespace: slmetric.config

(To be removed) Clear metric family parameter values

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.

Syntax

resetMetricFamilyParameterValues(config,... 'ModelAdvisorStandard')


Description

For an slmetric.config.Configuration object, use the resetMetricFamilyParameterValues(config,... 'ModelAdvisorStandard') method to clear the metric family parameter values. These values are the Check Group IDs corresponding to the check groups for which you obtain compliance and issues metric data. Compliance metric data is the percentage of passed checks. Issues metric data is the number of check issues.

Input Arguments

config — Configuration object

slmetric.config.Configuration object

slmetric.config.Configuration object for which to clear the metric family parameter values.

'ModelAdvisorStandard' — Required string

character vector | string scalar

Standard string that you must supply as an input.

Examples

Reset Metric Family Parameter Values

Obtain compliance and issues metric data on the Modeling Standards for MISRA C:2012, MAB, and High-Integrity Systems check groups.

Open the default configuration.

config = slmetric.config.Configuration.open();

Specify the metric family parameter ID, famParamID, and the metric family parameter values, values. The values maab and hisl_do178 correspond to subsets of MAAB checks and High-Integrity System checks. The MISRA value _SYSTEM_By Task_misra_c is the Check Group ID for the MISRA check group Modeling Standards for MISRA C:2012.

famParamID = 'ModelAdvisorStandard';
values = {'maab', 'hisl_do178', '_SYSTEM_By Task_misra_c'};
setMetricFamilyParameterValues(config, famParamID, values); 

To obtain the Model Advisor Check Group ID for a group of checks, open the Model Advisor Configuration Editor and select the desired folder of checks. The Check Group ID is shown in the Information tab. For more information on the Model Advisor Configuration Editor, see Use Model Advisor Configuration Editor to Customize Model Advisor.

Check the metric family parameter values associated with the slmetric.config.Configuration object.

ValuesArray = getMetricFamilyParameterValues(config, famParamID);

This code is for the ValuesArray cell array:

ValuesArray =

  3×1 cell array

    {'_SYSTEM_By Task_misra_c'}
    {'hisl_do178'             }
    {'maab'                   }

Reset the values.

resetMetricFamilyParameterValues(config, famParamID)

Check that the slmetric.config.Configuration object does have associated metric family parameter values.

ValuesArray = getMetricFamilyParameterValues(config, famParamID);

For more information, see Customize Metrics Dashboard Layout and Functionality.

Version History

Introduced in R2018b

R2022a: Metrics Dashboard will be removed

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.