arm4::QArmTransactionWithMetrics Class Reference
[ARM 4.0 Transactions, ARM 4.0 Metrics]
A subclass of QArmTransaction that is used if the application wishes to use metrics.
More...
Inheritance diagram for arm4::QArmTransactionWithMetrics:
Public Member Functions | |
| QArmTransactionWithMetrics (const QArmApplication &app, const QArmTransactionWithMetricsDefinition &definition, const QArmMetricGroup &group) | |
| Constructs 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 QArmTransaction that is used if the application wishes to use metrics.
All the QArmTransaction rules for using start(), stop(), etc., apply to this interface. It extends QArmTransaction by adding methods to manipulate metrics. The QArmMetric subclass objects are bound to an QArmTransactionWithMetrics object when it is created. This is done by specifying QArmMetricGroup in the QArmTransactionWithMetrics() constructor.
Constructor & Destructor Documentation
| arm4::QArmTransactionWithMetrics::QArmTransactionWithMetrics | ( | const QArmApplication & | app, | |
| const QArmTransactionWithMetricsDefinition & | definition, | |||
| const QArmMetricGroup & | 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 QArmMetricGroup& arm4::QArmTransactionWithMetrics::getMetricGroup | ( | ) | const [inline] |
returns the object that was bound when the object was created.
- Returns:
- the object that was bound when
QArmTransactionWithMetricsis created.
| const QArmTransactionWithMetricsDefinition& arm4::QArmTransactionWithMetrics::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:
