The mutable version of Message. More...
#include <message_m.h>
Inheritance diagram for MessageMutable:
Collaboration diagram for MessageMutable:
Public Member Functions | |
| MessageMutable (std::initializer_list< SourceID > sources={}) | |
| Message::Entry & | entry (unsigned int index) |
| Get an entry of the message. More... | |
| Message::Entry & | at (int index) |
| Get an entry of the message. More... | |
| Message::Entry & | operator[] (int index) |
| Get an entry of the message. More... | |
 Public Member Functions inherited from Message | |
| Message (const StreamObject &base) | |
| Message (std::initializer_list< SourceID > sources={}) | |
| const Entry & | entry (const std::string &name) const |
| Get an entry of the message. More... | |
| const Entry & | at (int index) const |
| Get an entry of the message. More... | |
| const Entry & | operator[] (int index) const |
| Get an entry of the message. More... | |
| int | size (void) const |
| Get the size of a message. More... | |
| Public Member Functions inherited from StreamObject | |
| SourceID | id (void) const |
| Get the SourceID of the object. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Message | |
| static StreamWidget * | initWidget (OutputPrivate *out) |
| Protected Member Functions inherited from StreamObject | |
| void | initSources (std::initializer_list< SourceID > sources={}) |
| Protected Attributes inherited from Message | |
| MessagePrivate * | _this |
| Protected Attributes inherited from StreamObject | |
| std::shared_ptr< StreamObjectPrivate > | _this_base |
Detailed Description
The mutable version of Message.
You can manipulate the message data in this class, but it will be always converted to the non-mutable version before it is sent to an item.
- See also
- Message
Member Function Documentation
◆ at()
| Message::Entry & MessageMutable::at | ( | int | index | ) |
Get an entry of the message.
- Parameters
-
index The index of the entry
- Returns
- The entry
This function checks the bounds and returns an invalid entry if the index is out of bounds.
Here is the call graph for this function:
◆ entry()
| Message::Entry & MessageMutable::entry | ( | unsigned int | index | ) |
Get an entry of the message.
- Parameters
-
name The name of the entry
- Returns
- The first entry with a matching name
If name is not found in the message, an invalid entry is returned.
◆ operator[]()
| Message::Entry & MessageMutable::operator[] | ( | int | index | ) |
Get an entry of the message.
- Parameters
-
index The index of the entry
- Returns
- The entry
WARNING: This function doesn't check the bounds!
The documentation for this class was generated from the following files:
- usercore/include/streams/message_m.h
- usercore/src/streams/message_m.cpp
