arm4::ArmMessageEventGroup Class Reference
[ARM 4.1]
Is a container for an array of ArmMessageEvent instances. More...
Public Member Functions | |
| ArmMessageEventGroup (bool endOfFlow=false) | |
| Constructs a message event group instance. | |
| virtual | ~ArmMessageEventGroup () |
| dtor | |
| int | clearAllEvents () |
| const ArmMessageEvent & | getEvent (int index) const |
| bool | isEndOfFlow () const |
| int | setEndOfFlow (bool b) |
| int | setEvent (int index, const ArmMessageEvent &event) |
Detailed Description
Is a container for an array of ArmMessageEvent instances.
Is a container for an array of ArmMessageEvent instances, plus an End of Flow indicator. It provides a convenient aggregation for providing the set of events to ArmTransaction.
The events are represented as an array of a maximum of 64 ArmMessageEvent instances. There is a further constraint that there can be no more than 32 send events and 32 receive events. For example, there could be 32 send events plus 10 receive events for a total of 42 events, but not 33 send events plus 10 receive events, even though the total number of events (43) is less than 64.
- Since:
- ARM 4.1
Constructor & Destructor Documentation
| arm4::ArmMessageEventGroup::ArmMessageEventGroup | ( | bool | endOfFlow = false |
) |
Constructs a message event group instance.
- Since:
- ARM 4.1
Member Function Documentation
| int arm4::ArmMessageEventGroup::clearAllEvents | ( | ) |
is equivalent to executing setEvent(index, null) for all possible index positions.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned
- Since:
- ARM 4.1
| const ArmMessageEvent& arm4::ArmMessageEventGroup::getEvent | ( | int | index | ) | const |
retrieves an event at the index.
- Parameters:
-
index index of the event to get.
- Since:
- ARM 4.1
| bool arm4::ArmMessageEventGroup::isEndOfFlow | ( | ) | const |
- Returns:
- the current value.
- Since:
- ARM 4.1
| int arm4::ArmMessageEventGroup::setEndOfFlow | ( | bool | b | ) |
indicates that the currently executing transaction represents the last processing step in a compound transaction that started in another process. In this case, the stop time of the currently executing transaction can be considered the stop time for the entire compound transaction. The default value is False for each transaction unless it is set to True with this method. It serves no purpose to set this flag to True and pass it to ArmTransaction more than once for a given transaction. setEndOfFlow(false) indicates that this condition does not exist, or at least is not known to exist.
- Parameters:
-
b end of flow status
- Since:
- ARM 4.1
| int arm4::ArmMessageEventGroup::setEvent | ( | int | index, | |
| const ArmMessageEvent & | event | |||
| ) |
inserts an event in the array at the specified index. setEvent(index, ArmMessageEvent::Null) clears the event at that index.
- Parameters:
-
index index to set or clear. event event to set or clear.
- 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/ArmMessageEventGroup
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH