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

Inheritance diagram for arm4::ArmTranReportWithMetrics:

Public Member Functions
	ArmTranReportWithMetrics (const ArmApplication &app, const ArmTransactionWithMetricsDefinition &definition, ArmMetricGroup &group)
	Creates 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 ArmTranReport that is used if the application wishes to use metrics.

All the ArmTranReport semantics for using report() apply to ArmTranReportWithMetrics. ArmTranReportWithMetrics extends ArmTranReport by adding methods to manipulate metrics.

The ArmMetric subclass objects are bound to an ArmTranReportWithMetrics object when the ArmTranReportWithMetrics is created. This is done by specifying ArmMetricGroup in the newArmTranReportWithMetrics() method of ArmMetricFactory.

Constructor & Destructor Documentation

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

Creates an object that represents an instance of a transaction.

The metadata about the transaction is supplied in an ArmTransactionWithMetricsDefinition object. An application instance (ArmApplication) provides a scoping context. The metrics are bound via an ArmMetricGroup object. If the metric group reference is null, the resulting ArmTranReportWithMetrics has no metrics, so it would have no more functions than an ArmTranReport object, except to return null to the getMetricGroup() method.

Parameters:

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

const ArmMetricGroup& arm4::ArmTranReportWithMetrics::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::ArmTranReportWithMetrics::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: