arm_metric Struct Reference
[ARM 4.0 Metrics]
used to pass a metric value to the ARM implementation. More...
#include <arm4.h>
Data Fields | |
| arm_metric_slot_t | slot |
| arm_metric_format_t | format |
| arm_metric_usage_t | usage |
| arm_boolean_t | valid |
| union { | |
| } | metric_u |
Detailed Description
used to pass a metric value to the ARM implementation.
- See also:
- arm_subbuffer_metric_values_t
Field Documentation
A single-byte format indicator. Valid formats are are listed below. ARM_METRIC_FORMAT_STRING32 is only valid in slot 6. All other formats are valid in slots 0-5. This is a carry-over from ARM 2.0. The format must be the same as the corresponding entry in the Metric Bindings sub-buffer (arm_subbuffer_metric_bindings_t):
| union { ... } arm_metric::metric_u |
A union containing the metric value. The data type matches the metric format indicator (above).
A single-byte slot number. Valid values are 0 to 6. The slot number must be the same as the corresponding entry in the Metric Bindings sub-buffer (arm_subbuffer_metric_bindings_t). Each slot number should be used at most once; if a slot number is re-used, the first entry is used and all others are ignored.
An usage indicating how the metric is used. The usage must be the same as the usage parameter passed on the arm_register_metric() call that registered the metric ID with the same slot number that is in the Metric Bindings sub-buffer (arm_subbuffer_metric_bindings_t).
A boolean that indicates whether the data in the "Metric value" field is currently valid.
The documentation for this struct was generated from the following file:
Documentation generated on Thu May 24 2018 22:24:14. © 2018 by MyARM GmbH