arm4::util::ArmTransactionSupportBase Class Reference
[ARM 4.0 Support Classes]
Base class for ARM transaction support classes. More...
Inheritance diagram for arm4::util::ArmTransactionSupportBase:
![](classarm4_1_1util_1_1ArmTransactionSupportBase.png)
Public Member Functions | |
void | markAbort () |
Mark ARM transaction as aborted. | |
void | markFailed (const std::string &diagnosticDetail=NullString) |
mark ARM transaction as failed and possibly pass a diagnostic details | |
void | markGood () |
Mark ARM transaction as good. | |
void | markUnknown () |
Mark ARM transaction as unknown. | |
Protected Member Functions | |
ArmTransactionSupportBase (ArmTransaction &tran, int32_t status=ArmConstants::STATUS_UNKNOWN, bool destroy=false) | |
Initializes the transaction support base class. | |
~ArmTransactionSupportBase () | |
dtor | |
void | stop () |
Stops the transaction. | |
void | setStatus (int32_t status) |
Sets the default status. |
Detailed Description
Base class for ARM transaction support classes.
Constructor & Destructor Documentation
arm4::util::ArmTransactionSupportBase::ArmTransactionSupportBase | ( | ArmTransaction & | tran, | |
int32_t | status = ArmConstants::STATUS_UNKNOWN , |
|||
bool | destroy = false | |||
) | [protected] |
Initializes the transaction support base class.
- Parameters:
-
tran ARM transaction to stop status Default transaction status to use on stop call destroy If true the ArmTransaction will be destroyed after stop
Member Function Documentation
void arm4::util::ArmTransactionSupportBase::markFailed | ( | const std::string & | diagnosticDetail = NullString |
) |
mark ARM transaction as failed and possibly pass a diagnostic details
- Parameters:
-
diagnosticDetail Diagnostic detail string
void arm4::util::ArmTransactionSupportBase::setStatus | ( | int32_t | status | ) | [protected] |
Sets the default status.
- Parameters:
-
status The new default status
The documentation for this class was generated from the following file:
- Arm4/Util/ArmTransactionSupportBase