org.arm4.arm40.metric
Class ArmMetricGauge32

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

public class ArmMetricGauge32
extends ArmMetric
implements ArmMetricGauge32

Implements a 32-bit integer gauge. It is the same as ARM 2.0 metric type=4 (ARM_Gauge32).

Objects implementing this interface are created using ArmMetricFactory.newArmMetricGauge32(org.opengroup.arm40.metric.ArmMetricGauge32Definition).

Author:
David Carter

Field Summary
protected  int m_gauge
           
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmMetricGauge32(ArmMetricDefinition definition)
          Create ARM Metric.
 
Method Summary
 int get()
          Gets the gauge value.
 int set(int value)
          Sets the gauge value.
 
Methods inherited from class org.arm4.arm40.metric.ArmMetric
getDefinition
 
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.ArmMetric
getDefinition
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Field Detail

m_gauge

protected int m_gauge
Constructor Detail

ArmMetricGauge32

public ArmMetricGauge32(ArmMetricDefinition definition)
Create ARM Metric.

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

get

public int get()
Description copied from interface: ArmMetricGauge32
Gets the gauge value.

Specified by:
get in interface ArmMetricGauge32
Returns:
the gauge value.

set

public int set(int value)
Description copied from interface: ArmMetricGauge32
Sets the gauge value.

Specified by:
set in interface ArmMetricGauge32
Parameters:
value - new gauge value.
Returns:
0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).