Public Member Functions

arm4::ArmTransactionWithMetrics Class Reference
[ARM 4.0 Transactions, ARM 4.0 Metrics]

A subclass of ArmTransaction that is used if the application wishes to use metrics. More...

Inheritance diagram for arm4::ArmTransactionWithMetrics:
arm4::ArmTransaction arm4::ArmInterface

List of all members.

Public Member Functions

 ArmTransactionWithMetrics (const ArmApplication &app, const ArmTransactionWithMetricsDefinition &definition, const ArmMetricGroup &group)
 Constructs an object that represents an instance of a transaction.
const
ArmTransactionWithMetricsDefinition & 		getTransactionWithMetricsDefinition () const
 returns the object that contains the metadata
const ArmMetricGroup & getMetricGroup () const
 returns the object that was bound when the object was created.

Detailed Description

A subclass of ArmTransaction that is used if the application wishes to use metrics.

All the ArmTransaction rules for using start(), stop(), etc., apply to this interface. It extends ArmTransaction by adding methods to manipulate metrics. The ArmMetric subclass objects are bound to an ArmTransactionWithMetrics object when it is created. This is done by specifying ArmMetricGroup in the ArmTransactionWithMetrics() constructor.

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

Constructor & Destructor Documentation

arm4::ArmTransactionWithMetrics::ArmTransactionWithMetrics ( const ArmApplication &  app,
const ArmTransactionWithMetricsDefinition &  definition,
const ArmMetricGroup &  group 
) [inline]

Constructs an object that represents an instance of a transaction.

Parameters:
app instance of the containing application (scope).
definition metadata about the transaction.
group metrics binding object.

Member Function Documentation

const ArmMetricGroup& arm4::ArmTransactionWithMetrics::getMetricGroup (  )  const [inline]

returns the object that was bound when the object was created.

Returns:
the object that was bound when ArmTransactionWithMetrics is created.
const ArmTransactionWithMetricsDefinition& arm4::ArmTransactionWithMetrics::getTransactionWithMetricsDefinition (  )  const [inline]

returns the object that contains the metadata

Returns:
the object that contains the metadata describing this transaction, including the metric definitions.
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