QSimpleArmCounter Class Reference

Class representing a numeric id derived from QArmMetric. More...

#include <qsimplearmtran.h>

Inheritance diagram for QSimpleArmCounter:

List of all members.

Public Types
enum	QMetricType { COUNTER, GAUGE, ID }
Public Member Functions
	QSimpleArmCounter (const QString &_name, const QString &_unit)
void	setValue (qint64 _value)
qint64	getValue () const
const arm_id_t *	getMetricId () const
void	fill (armsdk_subbuffer_metric_values_t *_mv) const
Protected Member Functions
void	registerMetric (const short slot)
Friends
class	QArmMetricList

---

Detailed Description

Class representing a numeric id derived from QArmMetric.

Definition at line 75 of file qsimplearmtran.h.

---

Member Enumeration Documentation

enum QArmMetric::QMetricType [inherited]

Types of metrics. Enumeration values: COUNTER  A counter. GAUGE  A gauge. ID  An id. Definition at line 68 of file qarmmetric.h.

---

Constructor & Destructor Documentation

QSimpleArmCounter::QSimpleArmCounter (  const QString &  _name, const QString &  _unit )

Contructor of a counter metric. Parameters: _name  Name of the metric. _unit  Unit if the metric. Definition at line 165 of file qsimplearmtran.cpp.

---

Member Function Documentation

void QArmMetric::fill (  armsdk_subbuffer_metric_values_t *  _mv  )  const [inherited]

Fill the current metric value into the provided sub-buffer. Parameters: _mv  Metric value sub-buffer to fill. Definition at line 78 of file qarmmetric.cpp. References QArmMetric::COUNTER, QArmMetric::GAUGE, QArmMetric::ID, QArmMetric::m_Type, and QArmMetric::metric.

const arm_id_t * QArmMetric::getMetricId (   )  const [inherited]

Returns: Get the metric binding id. Definition at line 72 of file qarmmetric.cpp. References QArmMetric::metric_binding.

qint64 QArmMetric::getValue (   )  const [inherited]

get the value of the metric. Definition at line 144 of file qarmmetric.cpp. References QArmMetric::COUNTER, QArmMetric::GAUGE, QArmMetric::ID, QArmMetric::m_Type, and QArmMetric::metric.

bool QArmMetric::isCounter (   )  const [inline, inherited]

Returns: true if metric is a counter. Definition at line 161 of file qarmmetric.h. References QArmMetric::COUNTER, and QArmMetric::m_Type.

bool QArmMetric::isGauge (   )  const [inline, inherited]

Returns: true if metric is a gauge. Definition at line 165 of file qarmmetric.h. References QArmMetric::GAUGE, and QArmMetric::m_Type.

bool QArmMetric::isId (   )  const [inline, inherited]

Returns: true if metric is a numeric ID. Definition at line 169 of file qarmmetric.h. References QArmMetric::ID, and QArmMetric::m_Type.

void QArmMetric::registerMetric (  const short  slot  )  [protected, inherited]

This method is called from QArmMetricList when a metric is appended to the list. Parameters: slot  Slot number used for this metric. Definition at line 106 of file qarmmetric.cpp. References QArmMetric::COUNTER, QArmMetric::GAUGE, QArmMetric::ID, QArmMetric::m_AppId, QArmMetric::m_Name, QArmMetric::m_Type, QArmMetric::m_Unit, QArmMetric::metric, and QArmMetric::metric_binding. Referenced by QArmMetricList::append().

void QArmMetric::setValue (  qint64  _value  )  [inherited]

set the value of the metric. Parameters: _value  The value of the metric Definition at line 134 of file qarmmetric.cpp. References QArmMetric::COUNTER, QArmMetric::GAUGE, QArmMetric::ID, QArmMetric::m_Type, and QArmMetric::metric.

---

Friends And Related Function Documentation

friend class QArmMetricList [friend, inherited]

Since there exists a strict binding between metric values and metric definitions using the slot mechanism the QArmMetricList class provides the slot number. Therefore it needs to execute the registerMetric() method. Definition at line 129 of file qarmmetric.h.

---

The documentation for this class was generated from the following files:

• qarm/qsimplearmtran.h
• qarm/qsimplearmtran.cpp

---