OpenGroup::arm40::Provisional::metric::IArmMetricGroup Interface Reference
[ARM 4.0 Metrics]
ArmMetricGroup is used to bind objects that implement a subclass of IArmMetric to an IArmTransactionWithMetrics or IArmTranReportWithMetrics object. More...
Inheritance diagram for OpenGroup::arm40::Provisional::metric::IArmMetricGroup:
Public Member Functions | |
| IArmMetric | getMetric (int index) |
| Returns the metric at the array index. | |
| bool | isMetricValid (int index) |
| Returns whether an ArmMetric subclass at this array index is valid. | |
| int | setMetricValid (int index, bool value) |
Indicates whether an IArmMetric subclass at this array index is valid. | |
Properties | |
| IArmMetricGroupDefinition | Definition [get] |
| returns the metric group definition used to create this object. | |
Detailed Description
Instances of ArmMetricGroup are created using the newArmMetricGroup() method of ArmMetricFactory.
For all methods taking an index parameter, this is the index into the IArmMetric array. It must have a value in the range 0:6. To remain consistent with ARM 2.0, any IArmMetric subclass except IArmMetricString32 can be assigned to elements 0:5 and only IArmMetricString32 can be assigned to element 6.
Objects implementing this interface are created using IArmMetricFactory.newArmMetricGroup
Member Function Documentation
| IArmMetric OpenGroup::arm40::Provisional::metric::IArmMetricGroup::getMetric | ( | int | index | ) |
- Parameters:
-
index the index into the IArmMetricarray. See comment in the interface description above.
- Returns:
- the metric at the array index. This value may be null.
| bool OpenGroup::arm40::Provisional::metric::IArmMetricGroup::isMetricValid | ( | int | index | ) |
- Parameters:
-
index the index into the IArmMetricarray. See comment in the interface description above.
- Returns:
- whether an ArmMetric subclass at this array index is valid.
| int OpenGroup::arm40::Provisional::metric::IArmMetricGroup::setMetricValid | ( | int | index, | |
| bool | value | |||
| ) |
This applies when any of the following calls are made:
-
IArmTranReportWithMetrics: report() -
IArmTransactionWithMetrics: start(), update(), stop()
- Parameters:
-
index the index into the IArmMetricarray. See comment in the interface description above.value If the valid flag is set then the metric value is processed.
- Returns:
- 0 on sucess; otherwise, a non-zero error code is returned (as specified in OpenGroup.arm40.Provisional.transaction.IArmInterface
Property Documentation
IArmMetricGroupDefinition OpenGroup::arm40::Provisional::metric::IArmMetricGroup::Definition [get] |
- Returns:
- the metric group definition used to create this object.
The documentation for this interface was generated from the following file:
- opengroup/arm40/provisional/metric/IArmMetricGroup.cs
Documentation generated on Thu May 24 2018 22:24:16. © 2018 by MyARM GmbH