org.arm4.arm40.metric
Class ArmMetricCounter32

java.lang.Object
  org.arm4.arm40.transaction.ArmInterface
      org.arm4.arm40.metric.ArmMetric
          org.arm4.arm40.metric.ArmMetricCounter32

All Implemented Interfaces:

ArmMetric, ArmMetricCounter32, ArmInterface

public class ArmMetricCounter32
extends ArmMetric
implements ArmMetricCounter32

Implements a 32-bit integer counter. It is the same as ARM 2.0 metric type=1 (ARM_Counter32).

Objects implementing this interface are created using ArmMetricFactory.newArmMetricCounter32(org.opengroup.arm40.metric.ArmMetricCounter32Definition).

Version:

$Revision$ $Date$

Author:

dcarter

Field Summary

protected int

m_counter

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

m_errorCode, m_factory

Constructor Summary

ArmMetricCounter32(ArmMetricDefinition definition)
Create ARM Metric.

Method Summary

int	get() Gets the counter value.
int	set(int 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 int m_counter

Constructor Detail

ArmMetricCounter32

public ArmMetricCounter32(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: ArmMetricCounter32

Gets the counter value.

Specified by:

get in interface ArmMetricCounter32

Returns:

the counter value.

set

public int set(int value)

Description copied from interface: ArmMetricCounter32

Sets the counter value.

Specified by:

set in interface ArmMetricCounter32

Parameters:

value - new counter value.

Returns:

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