arm4::QArmTranReportWithMetrics Class Reference
A subclass of QArmTranReport that is used if the application wishes to use metrics. More...
Public Member Functions | |
QArmTranReportWithMetrics (const QArmApplication &app, const QArmTransactionWithMetricsDefinition &definition, QArmMetricGroup &group) | |
Creates an object that represents an instance of a transaction. | |
const QArmTransactionWithMetricsDefinition & | getTransactionWithMetricsDefinition () const |
returns the object that contains the metadata | |
const QArmMetricGroup & | getMetricGroup () const |
returns the object that was bound when the object was created. |
Detailed Description
A subclass of QArmTranReport that is used if the application wishes to use metrics.
All the QArmTranReport semantics for using report() apply to QArmTranReportWithMetrics. QArmTranReportWithMetrics extends QArmTranReport by adding methods to manipulate metrics.
The QArmMetric subclass objects are bound to an QArmTranReportWithMetrics object when the QArmTranReportWithMetrics is created. This is done by specifying QArmMetricGroup in the newQArmTranReportWithMetrics() method of QArmMetricFactory.
Constructor & Destructor Documentation
arm4::QArmTranReportWithMetrics::QArmTranReportWithMetrics | ( | const QArmApplication & | app, | |
const QArmTransactionWithMetricsDefinition & | definition, | |||
QArmMetricGroup & | group | |||
) | [inline] |
Creates an object that represents an instance of a transaction.
The metadata about the transaction is supplied in an QArmTransactionWithMetricsDefinition object. An application instance (QArmApplication) provides a scoping context. The metrics are bound via an QArmMetricGroup object. If the metric group reference is null, the resulting QArmTranReportWithMetrics has no metrics, so it would have no more functions than an QArmTranReport 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.
Member Function Documentation
const QArmMetricGroup& arm4::QArmTranReportWithMetrics::getMetricGroup | ( | ) | const [inline] |
returns the object that was bound when the object was created.
- Returns:
- the object that was bound when
QArmTransactionWithMetrics
is created.
const QArmTransactionWithMetricsDefinition& arm4::QArmTranReportWithMetrics::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: