A metric is the item of information about the specific aspect of a model. The collection of various metrics can be used to evaluate the current state of the model. Calculated at regular intervals they can help to track the evolution of model development.
![](/plugins/servlet/widgetconnector/placeholder?thumb=Widget Connector&width=300&height=225)
For better understanding of further material, get acquainted with the following concepts Concept | Description |
---|
Metric Suite | A collection of parameter and metric definitions used to calculate the metrics that evaluate specific aspects of your model. | Parameter definition | The variable that is used to calculate metrics. It can be an element type (including both relationship and DSL element types), particular element, data type, or data type value. | Metric definition | The attribute of a Metric Suite defining the formula for calculating metrics according to the parameter values. | Validation-based metric definition | The attribute of a Metric Suite specifying the validation rule for calculating metrics according to the parameter values. |
In general, a Metric Suite is a Class with the «MetricSuite» stereotype applied. Both parameter and metric definitions are attributes of a Metric Suite. ![MagicDraw 19.0 LTR SP2 > Metric Suites > metric_suite.png](/download/attachments/42589940/metric_suite.png?version=1&modificationDate=1464186438677&api=v2)
One metric is the result of a single calculation of a metric definition. The metrics of all the metric definitions of a Metric Suite together with relevant parameters are stored in a single instance of a Metric Suite (as slot values). To analyse and manage instances of a Metric Suite with a modeling tool, use the Metric Table. ![MagicDraw 19.0 LTR SP2 > Metric Suites > metric_table.png](/download/attachments/42589940/metric_table.png?version=1&modificationDate=1464360019847&api=v2)
Creating Metric Suites
There are several conventions that you must know about Metric Suites before creating one: - Metric Suite must have a target. A target specifies model elements, for which metrics of the particular metric suite can be calculated. The target value can be any type of elements or even a particular element of your model.
- Metric Suite must have one parameter definition declared as context. The element, which is selected for calculating metrics, is automatically set as the value of the context parameter definition.
- Metric Suite must have a date tracker, so that you could see the timestamp of each metric.
To create and define a Metric Suite, complete the following steps: - Add a new Metric Suite to your model.
- Specify the target for the Metric Suite.
- Specify parameter definitions of the Metric Suite (including the context parameter definition).
- Build metric definitions and/or validation-based metric definitions.
It’s recommended to have a single person per project, who is responsible for creating and managing all the Metric Suites of the project. |
|