arm4::ArmMessageEvent Class Reference
[ARM 4.1]
Is a superclass for all the message event type interfaces. More...
Inheritance diagram for arm4::ArmMessageEvent:
Public Member Functions | |
| const std::string & | getDescription () const |
| bool | isMessageReceivedEvent () const |
| bool | isMessageSentEvent () const |
| int32_t | setDescription (const std::string &desc) |
| Sets the description of the message event. | |
| bool | isNull () const |
| ArmMessageEvent (bool rcvd=true) | |
| Constructs a message event instance. | |
Static Public Attributes | |
| static const ArmMessageEvent | Null |
| A null message event. | |
Detailed Description
Is a superclass for all the message event type interfaces.
The common behaviors of all message events are:
- Each event has a description that can be read and written using getDescription() and setDescription().
- Each event can indicate if it is a Received Event or Sent Event using isMessageReceivedEvent() or isMessageSentEvent().
- Since:
- ARM 4.1
Constructor & Destructor Documentation
| arm4::ArmMessageEvent::ArmMessageEvent | ( | bool | rcvd = true |
) |
Constructs a message event instance.
- Since:
- ARM 4.1
Member Function Documentation
| const std::string& arm4::ArmMessageEvent::getDescription | ( | ) | const |
- Returns:
- the description string
| bool arm4::ArmMessageEvent::isMessageReceivedEvent | ( | ) | const |
- Returns:
- true if its an received message event
| bool arm4::ArmMessageEvent::isMessageSentEvent | ( | ) | const |
- Returns:
- true if its an sent message event
| bool arm4::ArmMessageEvent::isNull | ( | ) | const |
- Returns:
- if its a null message event
| int32_t arm4::ArmMessageEvent::setDescription | ( | const std::string & | desc | ) |
Sets the description of the message event.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned
The documentation for this class was generated from the following file:
- Arm4/ArmMessageEvent
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH