Model Metrics

Collect model compliance metric data and create custom model metrics

You can use model metrics to assess that your model and code comply with size, complexity, and readability requirements. Use the model metric API to create custom model metrics, compute metric results, and export metric data. Use the Metrics Dashboard to visualize the metric data and compliance status for your model. To get started, see Collect and Explore Metric Data by Using the Metrics Dashboard.

Classes

expand all

Collect Model Metric Data

`slmetric.Engine`	(To be removed) Collect metric data on models or model components
`slmetric.metric.MetaInformation`	Set metadata for custom metrics
`slmetric.metric.Result`	(To be removed) Metric data for specified model component and metric algorithm
`slmetric.metric.ResultCollection`	(To be removed) Metric data for specified model metric
`slmetric.metric.ResultDetail`	(To be removed) Details about instances of `slmetric.metric.Result` objects
`slmetric.metric.ResultClassification`	Access metric data thresholds results

Customize Metrics Dashboard

`slmetric.config.Configuration`	Specify metric data categories and custom metric families
`slmetric.config.ThresholdConfiguration`	Specify metric and `slmetric.metric.Result` property for thresholding
`slmetric.config.Threshold`	Object for holding metric result thresholds
`slmetric.config.Classification`	Specify categorical metric data ranges
`slmetric.config.MetricRange`	Specify metric data threshold values
`slmetric.dashboard.Configuration`	Object containing information on Metrics Dashboard layout and widgets
`slmetric.dashboard.Container`	Widget for holding `slmetric.dashboard.Widget` and `slmetric.dashboard.CustomWidget` objects in Metrics Dashboard
`slmetric.dashboard.CustomWidget`	Object for holding custom Metrics Dashboard widgets
`slmetric.dashboard.Group`	Widget for holding `slmetric.dashboard.Container`, `slmetric.dashboard.Widget` and `slmetric.dashboard.CustomWidget` objects on Metrics Dashboard
`slmetric.dashboard.Layout`	Create object for holding Metrics Dashboard customizations
`slmetric.dashboard.Widget`	Object for holding Actual/Potential Reuse, System Interface, or System Info widgets

Create Custom Model Metric

`Advisor.component.Component`	Create component for metric analysis
`Advisor.component.Types`	Create `enum` class specifying component type
`slmetric.metric.Metric`	Abstract class for creating model metrics

Functions

expand all

Collect Model Metric Data

`metricsdashboard`	(To be removed) Open Metrics Dashboard
`slmetric.metric.getAvailableMetrics`	(To be removed) Obtain available metrics

Customize Metrics Dashboard

`slmetric.config.getActiveConfiguration`	Obtain file path and name of XML file containing active Metrics Dashboard custom configuration
`slmetric.config.setActiveConfiguration`	Activate custom configuration for metric engine to use
`slmetric.dashboard.setActiveConfiguration`	Activate custom metric dashboard layout
`slmetric.dashboard.getActiveConfiguration`	Obtain file path and name of XML file containing active Metrics Dashboard layout

Create Custom Model Metric

`slmetric.metric.createNewMetricClass`	Create new metric class for a custom model metric
`slmetric.metric.registerMetric`	Register a custom model metric with the model metric repository
`slmetric.metric.unregisterMetric`	Unregister a custom model metric from the model metric repository
`slmetric.metric.refresh`	Update available model metrics

Topics

Explore Metric Data

Collect and Explore Metric Data by Using the Metrics Dashboard
Collect and view metric data for quality assessment.
Collect Model Metrics Programmatically
Use the model metric API to programmatically collect metrics for a model, such as subsystem and block counts.
Model Metrics
Model metrics provided by MathWorks^® that return metric data on your model for size, complexity, readability, and compliance to standards and guidelines.
Model Metric Data Aggregation
Options for defining model metric data aggregation and returning aggregated model metric results.
Identify Modeling Clones with the Metrics Dashboard
You can use the Metrics Dashboard tool to enable subsystem reuse by identifying exact graphical clones across a model hierarchy.
Collect Model Metrics Using the Model Advisor
Assess model size, complexity, and readability, using the Model Advisor to run model metric checks.
Collect Compliance Data and Explore Results in the Model Advisor
This example shows how to collect model metric data by using the Metrics Dashboard and explore detailed compliance results and, fix compliance issues by using the Model Advisor.
Collect Metric Data Programmatically and View Data Through the Metrics Dashboard
This example shows how to use the model metrics API to collect model metric data for your model, and then explore the results by using the Metrics Dashboard.
Fix Metric Threshold Violations in a Continuous Integration Systems Workflow
Use a continuous integration workflow to investigate whether your model violates metric threshold values.
Compare Model Complexity and Code Complexity Metrics
Assess the complexity of your system in model-based design.

Customize Metrics and Dashboard Functionality

Rearrange and Remove Widgets in Metrics Dashboard
Rearrange and remove widgets in the default Metrics Dashboard layout.
Modify, Remove, and Add Metric Thresholds in Metrics Dashboard
Customize metric thresholds for the Metrics Dashboard.
Change Model Advisor Checks in Metrics Dashboard
Create custom Model Advisor metrics and display the results in the Metrics Dashboard.
Create a Custom Model Metric for Nonvirtual Block Count
Create a new model metric by using the slmetric.metric.createNewMetricClass function and defining the metric algorithm.
Create Layout with Custom Metric
Create a new Metrics Dashboard layout and add custom widgets.
Customize Metrics Dashboard Layout and Functionality
Configure compliance metrics, add metric thresholds, and customize Metrics Dashboard layout.