org.arm4.arm40.metric
Class ArmMetricNumericId64

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

public class ArmMetricNumericId64
extends ArmMetric
implements ArmMetricNumericId64

Implements a 32-bit integer numeric ID. It is the same as ARM 2.0 metric type=8 (ARM_NumericID64).

Objects implementing this interface are created using ArmMetricFactory.newArmMetricNumericId64(org.opengroup.arm40.metric.ArmMetricNumericId64Definition).

Author:
David Carter

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

protected long m_id
Constructor Detail

ArmMetricNumericId64

public ArmMetricNumericId64(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: ArmMetricNumericId64
Gets the numeric ID value.

Specified by:
get in interface ArmMetricNumericId64
Returns:
the numeric ID value.

set

public int set(long value)
Description copied from interface: ArmMetricNumericId64
Sets the numeric ID value.

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