org.arm4.arm40.metric
Class ArmMetricGaugeFloat32

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

public class ArmMetricGaugeFloat32
extends ArmMetric
implements ArmMetricGaugeFloat32

Implements a 32-bit floating-point gauge. It is roughly equivalent to the ARM 2.0 metric type=6 (ARM_GaugeDivr32). Instead of providing two integer values that can be divided to produce a floating-point value, which is what was done in the C bindings for ARM 2.0 and ARM 4.0, a floating-point value is provided directly.

Objects implementing this interface are created using ArmMetricFactory.newArmMetricGaugeFloat32(org.opengroup.arm40.metric.ArmMetricGaugeFloat32Definition).

Author:
David Carter

Field Summary
protected  float m_gauge
           
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmMetricGaugeFloat32(ArmMetricDefinition definition)
          Create ARM Metric.
 
Method Summary
 float get()
          Gets the gauge value.
 int set(float 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 float m_gauge
Constructor Detail

ArmMetricGaugeFloat32

public ArmMetricGaugeFloat32(ArmMetricDefinition definition)
Create ARM Metric.

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

get

public float get()
Description copied from interface: ArmMetricGaugeFloat32
Gets the gauge value.

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

set

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

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