Public Member Functions

arm4::QArmMetricGaugeFloat32 Class Reference
[ARM 4.0 Metric Gauges]

Implements a 32-bit floating-point gauge. More...

Inheritance diagram for arm4::QArmMetricGaugeFloat32:
arm4::QArmMetric arm4::QArmInterface

List of all members.

Public Member Functions

 QArmMetricGaugeFloat32 (const QArmMetricGaugeFloat32Definition &definition)
 Constructs a new metric instance.
float get () const
 Gets the gauge value.
int32_t set (float value)
 Sets the gauge value.

Detailed Description

Implements a 32-bit floating-point gauge.

It is roughly equivalent to the ARM 2.0 metric type=6 (ARM_GaugeDivr32). 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.

Author:
ARM Working Group of The Open Group, MyARM GmbH

Constructor & Destructor Documentation

arm4::QArmMetricGaugeFloat32::QArmMetricGaugeFloat32 ( const QArmMetricGaugeFloat32Definition &  definition  )  [inline]

Constructs a new metric instance.

Parameters:
definition the metadata describing this metric.

Member Function Documentation

float arm4::QArmMetricGaugeFloat32::get (  )  const [inline]

Gets the gauge value.

Returns:
the gauge value.
int32_t arm4::QArmMetricGaugeFloat32::set ( float  value  )  [inline]

Sets the gauge value.

Parameters:
value new gauge value.
Returns:
0 on sucess; otherwise, a non-zero error code is returned (as specified in QArmInterface).
The documentation for this class was generated from the following file:
MyARM
Documentation generated on Thu May 24 2018 22:24:18. © 2018 by MyARM GmbH