org.arm4.arm40.metric

Class ArmMetricNumericId32

java.lang.Object

org.arm4.arm40.transaction.ArmInterface

org.arm4.arm40.metric.ArmMetric

org.arm4.arm40.metric.ArmMetricNumericId32

All Implemented Interfaces:

ArmMetric, ArmMetricNumericId32, ArmInterface

public class ArmMetricNumericId32
extends ArmMetric
implements ArmMetricNumericId32

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

Objects implementing this interface are created using ArmMetricFactory.newArmMetricNumericId32(org.opengroup.arm40.metric.ArmMetricNumericId32Definition).

Author:

David Carter

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_id

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

m_errorCode, m_factory

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	get() Gets the numeric ID value.
int	set(int 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 int m_id

Constructor Detail

ArmMetricNumericId32

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

Gets the numeric ID value.

Specified by:

get in interface ArmMetricNumericId32

Returns:

the numeric ID value.

set

public int set(int value)

Description copied from interface: ArmMetricNumericId32

Sets the numeric ID value.

Specified by:

set in interface ArmMetricNumericId32

Parameters:

value - new numeric ID value.

Returns:

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