org.arm4.arm40.metric

Class ArmMetric

public class ArmMetric extends ArmInterface implements ArmMetric

The superclass for all the metric interfaces. The common behavior of all metric subclasses is: Objects that implement a subclass of ArmMetric are used with ArmTransactionWithMetrics and / or ArmTranReportWithMetrics. They are bound via ArmMetricGroup when the ArmTransactionWithMetrics or ArmTranReportWithMetrics instance is created. Each ArmMetric instance can be bound to any number of transaction instances.

Setting the value of the ArmMetric instance effectively sets the value for all the transaction instances to which it is bound. The value affects each ArmTransactionWithMetrics instance the next time a start(), update(), or stop() is executed on the instance. The value affects each ArmTranReportWithMetrics instance the next time a report() is executed on the instance.

This class cannot be instantiated. Objects that implement a subclass of ArmMetric are created using the newArmMetric...() methods of ArmMetricFactory.

Version: $Revision$ $Date$

Author: dcarter

Constructor Summary
protected ArmMetric(ArmMetricDefinition definition)
Create ARM Metric.
Method Summary
ArmMetricDefinitiongetDefinition()

Constructor Detail

ArmMetric

protected ArmMetric(ArmMetricDefinition definition)
Create ARM Metric.

Parameters: definition the descriptive metadata (name, units, usage, ID) for the metric

Method Detail

getDefinition

public ArmMetricDefinition getDefinition()