org.arm4.arm40.metric
Class ArmMetricCounter64

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

public class ArmMetricCounter64
extends ArmMetric
implements ArmMetricCounter64

Implements a 64-bit integer counter. It is the same as ARM 2.0 metric type=2 (ARM_Counter64).

Objects implementing this interface are created using ArmMetricFactory.newArmMetricCounter64(org.opengroup.arm40.metric.ArmMetricCounter64Definition).

Version:
$Revision$ $Date$
Author:
dcarter

Field Summary
protected  long m_counter
           
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmMetricCounter64(ArmMetricDefinition definition)
          Create ARM Metric.
 
Method Summary
 long get()
          Gets the counter value.
 int set(long value)
          Sets the counter 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_counter

protected long m_counter
Constructor Detail

ArmMetricCounter64

public ArmMetricCounter64(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: ArmMetricCounter64
Gets the counter value.

Specified by:
get in interface ArmMetricCounter64
Returns:
the counter value.

set

public int set(long value)
Description copied from interface: ArmMetricCounter64
Sets the counter value.

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