slmetric.Engine class
Package: slmetric
Superclasses:
(To be removed) Collect metric data on models or model components
slmetric.Engine
will be removed in a future release. For size,
architecture, and complexity metrics, use the metric.Engine
API and the
model maintainability metrics instead. For more information, see metric.Engine
and Collect Model Maintainability Metrics Programmatically.
Description
Use a slmetric.Engine
object to collect metric data on models by
calling execute
. Use getMetrics
to access the metric data and return an array of
slmetric.metric.ResultCollection
objects.
This metric data is persistent in the simulation cache folder. Future instantiations of
the slmetric.Engine
object for the same model can access the cached
metric data without regenerating the metric data.
Construction
metric_engine = slmetric.Engine()
creates a metric engine
object.
Properties
Methods
execute | (To be removed) Collect metric data |
exportMetrics | Export model metrics |
getAnalysisRootMetric | Get metric data for one metric for analysis root only |
getErrorLog | (To be removed) Get error log |
getMetricDistribution | Get metric distribution |
getMetricMetaInformation | Obtain metric metadata |
getMetrics | (To be removed) Access model metric data |
getStatistics | Get statistics on metric data |
setAnalysisRoot | Specify model or subsystem for metric analysis |