arm4::ArmBlockCause Class Reference
[ARM 4.1]
describes the cause of a blocking condition. More...
Inheritance diagram for arm4::ArmBlockCause:
Public Member Functions | |
| ArmBlockCause (const std::string &desc=NullString, const int32_t causeID=ArmConstants::BLOCK_CAUSE_SYNCHRONOUS_EVENT, const int32_t extendedCauseID=0) | |
| Constructs block cause instance. | |
| ArmBlockCause (const ArmBlockCause &blockcause) | |
| Constructs a block cause by copying the provided instance. | |
| const std::string | getDescription () const |
| int32_t | getExtendedCause () const |
| int32_t | getCause () const |
| int32_t | setDescription (const std::string &desc) |
| int32_t | setExtendedCause (int32_t extendedCauseID) |
| int32_t | setCause (int32_t causeID) |
Detailed Description
describes the cause of a blocking condition.
Its use is optional. When used, it is passed on ArmTransaction::blocked(). The Cause ID must be one of the following values. All other values are reserved.
No Extended Cause ID values are currently defined. The range of possible values are partitioned as follows:
- All non-negative values are reserved by the standard.
- All negative values are not defined by the standard. There are no restrictions on who uses these values or what they mean.
The Description is a String with a maximum of 127 characters.
- Since:
- ARM 4.1
Constructor & Destructor Documentation
| arm4::ArmBlockCause::ArmBlockCause | ( | const std::string & | desc = NullString, |
|
| const int32_t | causeID = ArmConstants::BLOCK_CAUSE_SYNCHRONOUS_EVENT, |
|||
| const int32_t | extendedCauseID = 0 | |||
| ) |
Constructs block cause instance.
- Parameters:
-
desc Description string of the block cause causeID The block cause extendedCauseID The extended cause id for the block cause
- Since:
- ARM 4.1
| arm4::ArmBlockCause::ArmBlockCause | ( | const ArmBlockCause & | blockcause | ) |
Constructs a block cause by copying the provided instance.
- Parameters:
-
blockcause Instance to construct a copy of.
- Since:
- ARM 4.1
Member Function Documentation
| int32_t arm4::ArmBlockCause::getCause | ( | ) | const |
- Returns:
- the block cause.
- See also:
- ArmConstants::BLOCK_CAUSE_SYNCHRONOUS_EVENT and ArmConstants.BLOCK_* constants.
- Since:
- ARM 4.1
| const std::string arm4::ArmBlockCause::getDescription | ( | ) | const |
- Returns:
- the description of the block cause.
- Since:
- ARM 4.1
| int32_t arm4::ArmBlockCause::getExtendedCause | ( | ) | const |
- Returns:
- the extended block cause.
- Since:
- ARM 4.1
| int32_t arm4::ArmBlockCause::setCause | ( | int32_t | causeID | ) |
sets the block cause
- Parameters:
-
causeID cause ID to set.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned
- See also:
- ArmConstants::BLOCK_CAUSE_SYNCHRONOUS_EVENT and ArmConstants::BLOCK_* constants.
- Since:
- ARM 4.1
| int32_t arm4::ArmBlockCause::setDescription | ( | const std::string & | desc | ) |
sets the description string for the block cause.
- Parameters:
-
desc description string to set.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned
- Since:
- ARM 4.1
| int32_t arm4::ArmBlockCause::setExtendedCause | ( | int32_t | extendedCauseID | ) |
sets the extended cause id for the block cause.
- Parameters:
-
extendedCauseID extended cause to set.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned
- Since:
- ARM 4.1
The documentation for this class was generated from the following file:
- Arm4/ArmBlockCause
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH