A counting down transaction container for stopping a started when the initialized number of events occured. More...

Inheritance diagram for arm4::util::ArmTransactionCountDown:

Public Member Functions
	ArmTransactionCountDown (ArmTransaction &tran, int32_t status=ArmConstants::STATUS_UNKNOWN)
	Initializes an ARM countdown latch which stops a ARM transaction if count drops to zero.
void	start (size_t events, const ArmCorrelator &parentCorr=ArmCorrelator::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::ArmTransactionCountDown::ArmTransactionCountDown	(	ArmTransaction &	tran,
		int32_t	status = `ArmConstants::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

bool arm4::util::ArmTransactionCountDown::countDown ( )

Counts the latchs number of events down by one.

void arm4::util::ArmTransactionCountDown::start	(	size_t	events,
		const ArmCorrelator &	parentCorr = `ArmCorrelator::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: