Public Member Functions

arm4::ArmMetricGroupDefinition Class Reference

Is used to bind ArmMetricDefinition objects to an ArmTransactionWithMetricsDefinition or ArmTranReportWithMetricsDefinition object. More...

Inheritance diagram for arm4::ArmMetricGroupDefinition:
arm4::ArmInterface

List of all members.

Public Member Functions

 ArmMetricGroupDefinition (const std::vector< ArmMetricDefinition * > &definitions)
 Constructs an ordered set of ArmMetricDefinition subclasses ready for binding to transaction definition objects.
const ArmMetricDefinition * getMetricDefinition (int32_t index) const
 Gets the metric definition at the specified index.

Detailed Description

Is used to bind ArmMetricDefinition objects to an ArmTransactionWithMetricsDefinition or ArmTranReportWithMetricsDefinition 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::ArmMetricGroupDefinition::ArmMetricGroupDefinition ( const std::vector< ArmMetricDefinition * > &  definitions  ) 

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

Parameters:
definitions An vector of ArmMetricDefinition 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 ArmMetricDefinition subclass except ArmMetricString32Definition can be assigned to elements 0:5 and only ArmMetricString32Definition 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 ArmMetricDefinition reference in element 0 and 6, and null pointer references in elements 1:5.

Member Function Documentation

const ArmMetricDefinition* arm4::ArmMetricGroupDefinition::getMetricDefinition ( int32_t  index  )  const

Gets the metric definition at the specified index.

Parameters:
index is the index into the ArmMetricDefinition vector.

It must have a value in the range 0:6. To remain consistent with ARM 2.0, any ArmMetricDefinition subclass except ArmMetricString32Definition can be assigned to elements 0:5 and only ArmMetricString32Definition 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:
MyARM
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH