arm4::util::QArmTransactionCountDown Class Reference
[ARM 4.0 Support Classes]
A counting down transaction container for stopping a started when the initialized number of events occured. More...
Inheritance diagram for arm4::util::QArmTransactionCountDown:

Public Member Functions | |
QArmTransactionCountDown (QArmTransaction &tran, int32_t status=QArmConstants::STATUS_UNKNOWN) | |
Initializes an ARM countdown latch which stops a ARM transaction if count drops to zero. | |
void | start (size_t events, const QArmCorrelator &parentCorr=QArmCorrelator::Null) |
Initializes the countdown latch with an initial number of events. | |
bool | countDown () |
Counts the latchs number of events down by one. |
Detailed Description
A counting down transaction container for stopping a started when the initialized number of events occured.
Constructor & Destructor Documentation
arm4::util::QArmTransactionCountDown::QArmTransactionCountDown | ( | QArmTransaction & | tran, | |
int32_t | status = QArmConstants::STATUS_UNKNOWN | |||
) |
Initializes an ARM countdown latch which stops a ARM transaction if count drops to zero.
- Parameters:
-
tran Started ARM transaction to stop on finished() status Default transaction status to use on stop call
Member Function Documentation
bool arm4::util::QArmTransactionCountDown::countDown | ( | ) |
Counts the latchs number of events down by one.
- Returns:
- true if transaction was stopped otherwise false
- Note:
- When the count drops to zero associated transaction is stopped
void arm4::util::QArmTransactionCountDown::start | ( | size_t | events, | |
const QArmCorrelator & | parentCorr = QArmCorrelator::Null | |||
) |
Initializes the countdown latch with an initial number of events.
- Parameters:
-
events Number of events to countdown before stopping (zero is invalid) parentCorr Parent correlator (if any)
The documentation for this class was generated from the following file:
- QArm4/Util/QArmTransactionCountDown