org.opengroup.arm40.metric

Interface ArmMetricGroupDefinition

All Superinterfaces:

ArmInterface

All Known Implementing Classes:

ArmMetricGroupDefinition

public interface ArmMetricGroupDefinition
extends ArmInterface

Is used to bind ArmMetricDefinition objects to an ArmTransactionWithMetricsDefinition or ArmTranReportWithMetricsDefinition object. The binding occurs when the transaction object is created using newArmTransactionWithMetricsDefinition() or newArmTranReportWithMetricsDefinition() and is immutable afterwards.

Objects implementing this interface are created using ArmMetricFactory.newArmMetricGroupDefinition(org.opengroup.arm40.metric.ArmMetricDefinition[]).

Author:

ARM Working Group of The Open Group

Method Summary

Methods

Modifier and Type	Method and Description
ArmMetricDefinition	getMetricDefinition(int index)

Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, setErrorCode

Method Detail

getMetricDefinition

ArmMetricDefinition getMetricDefinition(int index)

Parameters:

index - is the index into the ArmMetricDefinition array.

It must have a value in the range 0:6. To remain consistent with ARM 2.0, any ArmMetricDefinition subclass except ArmMetricString32Definition can be assigned to elements 0:5 and only ArmMetricString32Definition can be assigned to element 6.

Returns:

the metric at the array index. This value may be null.