Public Member Functions

arm4::util::ArmTransactionEventCounter Class Reference
[ARM 4.0 Support Classes]

An event handling ARM transaction container. The transaction is started if the first event started and stopped when the last event finished. More...

Inheritance diagram for arm4::util::ArmTransactionEventCounter:
arm4::util::ArmTransactionSupportBase

List of all members.

Public Member Functions

 ArmTransactionEventCounter (ArmTransaction &tran, const ArmCorrelator &parent=ArmCorrelator::Null, int32_t status=ArmConstants::STATUS_UNKNOWN, bool destroy=false)
 Initializes an ARM transaction event counter. It starts the ARM transaction when the first event started and stops the measurement when the last event* finished.
void reset ()
 Resets the transaction event counter and possible drops a started transaction.
void started ()
 Indicates that an event started.
bool finished ()
 Indicates that an event finished.

Detailed Description

An event handling ARM transaction container. The transaction is started if the first event started and stopped when the last event finished.

Author:
MyARM GmbH

Constructor & Destructor Documentation

arm4::util::ArmTransactionEventCounter::ArmTransactionEventCounter ( ArmTransaction &  tran,
const ArmCorrelator &  parent = ArmCorrelator::Null,
int32_t  status = ArmConstants::STATUS_UNKNOWN,
bool  destroy = false 
)

Initializes an ARM transaction event counter. It starts the ARM transaction when the first event started and stops the measurement when the last event* finished.

Parameters:
tran ARM transaction to start and stop
parent Parent correlator
status Default transaction status to use on stop call
destroy If true destroy the ARM transaction instance

Member Function Documentation

bool arm4::util::ArmTransactionEventCounter::finished (  ) 

Indicates that an event finished.

Returns:
true if transaction was stopped otherwise false
void arm4::util::ArmTransactionEventCounter::started (  ) 

Indicates that an event started.

Note:
The first event will start the ARM transaction
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