arm4::QArmMetricGroupDefinition Class Reference

Is used to bind QArmMetricDefinition objects to an QArmTransactionWithMetricsDefinition or QArmTranReportWithMetricsDefinition object. More...

Inheritance diagram for arm4::QArmMetricGroupDefinition:
arm4::QArmInterface

List of all members.

Public Member Functions

 QArmMetricGroupDefinition (const QVector< QArmMetricDefinition * > &definitions)
 Constructs an ordered set of QArmMetricDefinition subclasses ready for binding to transaction definition objects.
const QArmMetricDefinitiongetMetricDefinition (int32_t index) const
 Gets the metric definition at the specified index.

Detailed Description

Is used to bind QArmMetricDefinition objects to an QArmTransactionWithMetricsDefinition or QArmTranReportWithMetricsDefinition object.

The binding occurs when the transaction object is created and is immutable afterwards.

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

Constructor & Destructor Documentation

arm4::QArmMetricGroupDefinition::QArmMetricGroupDefinition ( const QVector< QArmMetricDefinition * > &  definitions  ) 

Constructs an ordered set of QArmMetricDefinition subclasses ready for binding to transaction definition objects.

Parameters:
definitions An vector of QArmMetricDefinition objects.

The ordering in the vector is important. The vector can have up to seven elements and is position-sensitive. To remain consistent with ARM 2.0, any QArmMetricDefinition subclass except QArmMetricString32Definition can be assigned to elements 0:5 and only QArmMetricString32Definition can be assigned to element 6.

Any element can be a null pointer. If the input vector has fewer than seven elements, the rest of the elements are assigned a value of a null pointer. The vector can be sparsely populated. For example, there can be a non-null pointer QArmMetricDefinition reference in element 0 and 6, and null pointer references in elements 1:5.


Member Function Documentation

const QArmMetricDefinition* arm4::QArmMetricGroupDefinition::getMetricDefinition ( int32_t  index  )  const

Gets the metric definition at the specified index.

Parameters:
index is the index into the QArmMetricDefinition vector.

It must have a value in the range 0:6. To remain consistent with ARM 2.0, any QArmMetricDefinition subclass except QArmMetricString32Definition can be assigned to elements 0:5 and only QArmMetricString32Definition can be assigned to element 6.

Returns:
the metric at the vector index. This value may be a null pointer.

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