org.opengroup.arm40.metric
Interface ArmMetricGaugeFloat32

All Superinterfaces:
ArmInterface, ArmMetric
All Known Implementing Classes:
ArmMetricGaugeFloat32

public interface ArmMetricGaugeFloat32
extends ArmMetric

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:
ARM Working Group of The Open Group

Method Summary
 float get()
          Gets the gauge value.
 int set(float value)
          Sets the gauge value.
 
Methods inherited from interface org.opengroup.arm40.metric.ArmMetric
getDefinition
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Method Detail

get

float get()
Gets the gauge value.

Returns:
the gauge value.

set

int set(float value)
Sets the gauge value.

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