org.arm4.arm40.metric

Class ArmMetricGauge64

java.lang.Object

org.arm4.arm40.transaction.ArmInterface

org.arm4.arm40.metric.ArmMetric

org.arm4.arm40.metric.ArmMetricGauge64

All Implemented Interfaces:

ArmMetric, ArmMetricGauge64, ArmInterface

public class ArmMetricGauge64
extends ArmMetric
implements ArmMetricGauge64

Implements a 64-bit integer gauge. It is the same as ARM 2.0 metric type=5 (ARM_Gauge64).

Objects implementing this interface are created using ArmMetricFactory.newArmMetricGauge64(org.opengroup.arm40.metric.ArmMetricGauge64Definition).

Author:

David Carter

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_gauge

Fields inherited from class org.arm4.arm40.transaction.ArmInterface

m_errorCode, m_factory

Constructor Summary

Constructors

Constructor and Description
ArmMetricGauge64(ArmMetricDefinition definition) Create ARM Metric.

Method Summary

Methods

Modifier and Type	Method and Description
long	get() Gets the gauge value.
int	set(long 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 long m_gauge

Constructor Detail

ArmMetricGauge64

public ArmMetricGauge64(ArmMetricDefinition definition)

Create ARM Metric.

Parameters:

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

Method Detail

get

public long get()

Description copied from interface: ArmMetricGauge64

Gets the gauge value.

Specified by:

get in interface ArmMetricGauge64

Returns:

the gauge value.

set

public int set(long value)

Description copied from interface: ArmMetricGauge64

Sets the gauge value.

Specified by:

set in interface ArmMetricGauge64

Parameters:

value - new gauge value.

Returns:

0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).