arm4::ArmMetricCounterFloat32 Class Reference
[ARM 4.0 Metric Counters]
Implements a 32-bit floating-point counter. More...
Inheritance diagram for arm4::ArmMetricCounterFloat32:
Public Member Functions | |
ArmMetricCounterFloat32 (const ArmMetricCounterFloat32Definition &definition) | |
Constructs a new metric instance. | |
float | get () const |
Gets the counter value. | |
int32_t | set (float value) |
Sets the counter value. |
Detailed Description
Implements a 32-bit floating-point counter.
It is roughly equivalent to the ARM 2.0 metric type=3 (ARM_CntrDivr32
). Instead of providing two integer values that can be divided to produce a floating-point value, which is what was done in the C bindings for ARM 2.0 and ARM 4.0, a floating-point value is provided directly.
Constructor & Destructor Documentation
arm4::ArmMetricCounterFloat32::ArmMetricCounterFloat32 | ( | const ArmMetricCounterFloat32Definition & | definition | ) | [inline] |
Constructs a new metric instance.
- Parameters:
-
definition the metadata describing this metric.
Member Function Documentation
float arm4::ArmMetricCounterFloat32::get | ( | ) | const [inline] |
Gets the counter value.
- Returns:
- the counter value.
int32_t arm4::ArmMetricCounterFloat32::set | ( | float | value | ) | [inline] |
Sets the counter value.
- Parameters:
-
value new counter value.
- Returns:
- 0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).
The documentation for this class was generated from the following file: