public interface ArmMetricGroup extends ArmInterface
ArmMetric
to an
ArmTransactionWithMetricsDefinition
or
ArmTranReportWithMetricsDefinition
object.
The binding occurs when the transaction object is created using
newArmTransactionWithMetrics()
or
newArmTranReportWithMetrics()
and is immutable
afterwards.
For all methods taking an index
parameter, this
is the index into the ArmMetric
array.
It must have a value in the range 0:6. To remain consistent with
ARM 2.0, any ArmMetric
subclass except
ArmMetricString32
can be assigned to elements 0:5
and only ArmMetricString32
can be assigned to element 6.
Objects implementing this interface are created using
ArmMetricFactory.newArmMetricGroup(org.opengroup.arm40.metric.ArmMetricGroupDefinition, org.opengroup.arm40.metric.ArmMetric[])
.Modifier and Type | Method and Description |
---|---|
ArmMetricGroupDefinition |
getDefinition() |
ArmMetric |
getMetric(int index) |
boolean |
isMetricValid(int index) |
int |
setMetricValid(int index,
boolean value)
Indicates whether an
ArmMetric subclass at this array
index is valid. |
getErrorCode, getErrorMessage, setErrorCode
ArmMetricGroupDefinition getDefinition()
ArmMetric getMetric(int index)
index
- the index into the ArmMetric
array. See
comment in the interface description above.boolean isMetricValid(int index)
index
- the index into the ArmMetric
array. See
comment in the interface description above.int setMetricValid(int index, boolean value)
ArmMetric
subclass at this array
index is valid.
This applies when any of the following calls are made:
ArmTranReportWithMetrics: report()
ArmTransactionWithMetrics: start(), update(),
stop()
index
- index the index into the ArmMetric
array. See
comment in the interface description above.value
- If the valid flag is set then the metric value is
processed.ArmInterface
).