arm4::QArmMetricDefinition Class Reference
[ARM 4.0 Metrics]

The base class for all the metric definition interfaces. More...

Inheritance diagram for arm4::QArmMetricDefinition:
arm4::QArmInterface arm4::QArmMetricCounter32Definition arm4::QArmMetricCounter64Definition arm4::QArmMetricCounterFloat32Definition arm4::QArmMetricGauge32Definition arm4::QArmMetricGauge64Definition arm4::QArmMetricGaugeFloat32Definition arm4::QArmMetricNumericId32Definition arm4::QArmMetricNumericId64Definition arm4::QArmMetricString32Definition

List of all members.

Public Member Functions

const QArmIDgetID () const
 Gets the (optional) ID for this definition.
const QString & getName () const
 Gets the name of this definition.
const QString & getUnits () const
 Gets the (optional) units description.
int16_t getUsage () const
 Gets the usage semantics.

Static Public Attributes

static const int16_t METRIC_USE_GENERAL = 0
static const int16_t METRIC_USE_TRAN_SIZE = 1
static const int16_t METRIC_USE_TRAN_STATUS = 2
static const int16_t EXT_METRIC_USE_TRAN_CONCURRENCY = -3

Detailed Description

The base class for all the metric definition interfaces.

All the methods are defined in QArmMetricDefinition. The subclasses serve as markers for the data types. All the publicly accessible attributes are immutable and have a getter method for them.

The attributes are:

  • The definition of the application that contains the transaction.
  • Name. The maximum length is 127 characters. The name must not be a NullString or zero-length.
  • Units. An optional string describing the units of measurement, such as "files" or "jobs in queue". It may be a NullString.
  • Usage. Describes any additional information about the semantics of the metric. Most metrics will be classified as "general", indicating that there is no specific semantic declared. The two specific semantics are the size of the transaction, such as the number of files that were backed up, and a status that could contain data, such as an error code that describes why a transaction failed. See the field descriptions of METRIC_USE_... below for the defined values. Any negative value is also permitted; the negative range is reserved for application-specific values.
  • Optional ID. An optional 16-byte ID may be associated with the identity of a metric definition. The returned value, which could be QArmID::Null, is the same value passed to the constructor. The ID value is bound to a unique combination of the metric format (e.g., Counter32), name, usage, and unit properties. When provided, the ID may be used as a concise alias for the unique combination. It may be a QArmID::Null.

This class cannot be instantiated.

ARM Working Group of The Open Group, MyARM GmbH

Member Function Documentation

const QArmID& arm4::QArmMetricDefinition::getID (  )  const

Gets the (optional) ID for this definition.

the ID or QArmID::Null.
const QString& arm4::QArmMetricDefinition::getName (  )  const

Gets the name of this definition.

the definition name.
const QString& arm4::QArmMetricDefinition::getUnits (  )  const

Gets the (optional) units description.

the units desciption or null.
int16_t arm4::QArmMetricDefinition::getUsage (  )  const

Gets the usage semantics.

One of METRIC_USE_GENERAL, METRIC_USE_TRAN_SIZE, METRIC_USE_TRAN_STATUS, or an application-specific negative value.

Member Data Documentation

Metric explains the concurrent usage of a transaction. (gauge only)

No specific usage semantics are declared.

Metric represents the "size" of the transaction (counter & gauge only).

Metric represents status, like an error code (numeric ID & string only).

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