OpenGroup::arm40::Provisional::metric::IArmMetric Interface Reference
[ARM 4.0 Metrics]
The superclass for all the metric interfaces. More...
Public Member Functions | |
| IArmMetricDefinition | getDefinition () |
| returns the descriptive metadata about the metric. | |
Detailed Description
The common behavior of all metric subclasses is:
-
getDefinition()returns the descriptive metadata (name, units, usage, ID) about the metric. The returned object will be the appropriate subclass ofIArmMetricDefinition -
Each subclass is also expected to implement
get()andset()methods that take and/or return data of the appropriate type for the subclass. These methods are not defined in this interface because they have different signatures, depending on the type of metric.
Objects that implement a subclass of ArmMetric are used with IArmTransactionWithMetrics and / or IArmTranReportWithMetrics They are bound via IArmMetricGroup when the IArmTransactionWithMetrics or IArmTranReportWithMetrics instance is created. Each IArmMetric instance can be bound to any number of transaction instances.
Setting the value of the IArmMetric instance effectively sets the value for all the transaction instances to which it is bound. The value affects each IArmTransactionWithMetrics instance the next time a start(), update(), or stop() is executed on the instance. The value affects each IArmTranReportWithMetrics instance the next time a report() is executed on the instance.
This class cannot be instantiated. Objects that implement a subclass of IArmMetric are created using the newArmMetric...() methods of IArmMetricFactory
Member Function Documentation
| IArmMetricDefinition OpenGroup::arm40::Provisional::metric::IArmMetric::getDefinition | ( | ) |
- Returns:
- the descriptive metadata (name, units, usage, ID) about the metric.
The documentation for this interface was generated from the following file:
- opengroup/arm40/provisional/metric/IArmMetric.cs
Documentation generated on Thu May 24 2018 22:24:16. © 2018 by MyARM GmbH