org.arm4.arm40.metric
Class ArmMetricGauge64Definition

java.lang.Object
  extended by org.arm4.arm40.transaction.ArmInterface
      extended by org.arm4.arm40.metric.ArmMetricDefinition
          extended by org.arm4.arm40.metric.ArmMetricGauge64Definition
All Implemented Interfaces:
ArmMetricDefinition, ArmMetricGauge64Definition, ArmInterface

public class ArmMetricGauge64Definition
extends ArmMetricDefinition
implements ArmMetricGauge64Definition

Marks a metadata binding. This is a subclass of ArmMetricDefinition serving as a marker interface that binds the metadata in ArmMetricDefinition to the metric data type, and describes an object interface that can be instantiated (there are no factory methods for objects that implement only ArmMetricDefinition). No new methods beyond those in ArmMetricDefinition are added.

Objects implementing this interface are created using ArmMetricFactory.newArmMetricGauge64Definition(org.opengroup.arm40.transaction.ArmApplicationDefinition, java.lang.String, java.lang.String, short, org.opengroup.arm40.transaction.ArmID).

Author:
David Carter

Field Summary
 
Fields inherited from class org.arm4.arm40.metric.ArmMetricDefinition
ARM_METRIC_FORMAT_CNTRDIVR32, ARM_METRIC_FORMAT_COUNTER32, ARM_METRIC_FORMAT_COUNTER64, ARM_METRIC_FORMAT_GAUGE32, ARM_METRIC_FORMAT_GAUGE64, ARM_METRIC_FORMAT_GAUGEDIVR32, ARM_METRIC_FORMAT_NUMERICID32, ARM_METRIC_FORMAT_NUMERICID64, ARM_METRIC_FORMAT_STRING32, m_appDefinition, m_format, m_metricId, m_name, m_units, m_usage, METRIC_USE_GENERAL, METRIC_USE_TRAN_SIZE, METRIC_USE_TRAN_STATUS
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Fields inherited from interface org.opengroup.arm40.metric.ArmMetricDefinition
METRIC_USE_GENERAL, METRIC_USE_TRAN_SIZE, METRIC_USE_TRAN_STATUS
 
Constructor Summary
ArmMetricGauge64Definition(ArmApplicationDefinition definition, java.lang.String name, java.lang.String units, short usage, ArmID id)
          Create the ARM metric definition.
 
Method Summary
 
Methods inherited from class org.arm4.arm40.metric.ArmMetricDefinition
getApplicationDefinition, getID, getName, getUnits, getUsage
 
Methods inherited from class org.arm4.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opengroup.arm40.metric.ArmMetricDefinition
getID, getName, getUnits, getUsage
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Constructor Detail

ArmMetricGauge64Definition

public ArmMetricGauge64Definition(ArmApplicationDefinition definition,
                                  java.lang.String name,
                                  java.lang.String units,
                                  short usage,
                                  ArmID id)
Create the ARM metric definition. This is noremally called using ArmMetricFactory.newArmMetricGauge64Definition(org.opengroup.arm40.transaction.ArmApplicationDefinition, java.lang.String, java.lang.String, short, org.opengroup.arm40.transaction.ArmID).

Parameters:
definition - the descriptive metadata for the application
name - the metric name
units - an optional string describing the units of measurement, such as "files" or "jobs in queue". It may be null.
usage - descibes the semantics of the metric's usage
id - an optional 16-byte ID