MsgIter Class Reference
Implements iterator for reading messages. More...
#include <MsgIter.hh>
Public Member Functions | |
MsgIter () | |
Default constructor. | |
MsgIter (MsgIter &&_orig) | |
Move Constructor. | |
~MsgIter () | |
Destructor;. | |
bool | operator!= (const MsgIter &_other) const |
Inequality operator. | |
const Message & | operator* () const |
Dereference Operator. | |
MsgIter & | operator++ () |
Copy-assignment operator. | |
const Message * | operator-> () const |
arrow dereference operator | |
MsgIter & | operator= (MsgIter &&_other) |
Move assignment operator. | |
bool | operator== (const MsgIter &_other) const |
Equality operator. | |
Detailed Description
Implements iterator for reading messages.
Constructor & Destructor Documentation
🔗MsgIter() [1/2]
MsgIter | ( | ) |
Default constructor.
🔗MsgIter() [2/2]
🔗~MsgIter()
~MsgIter | ( | ) |
Destructor;.
Member Function Documentation
🔗operator!=()
bool operator!= | ( | const MsgIter & | _other | ) | const |
Inequality operator.
- Parameters
-
[in] _other the iterator this is being compared to
- Returns
- false if the two iterator point to the same message
🔗operator*()
const Message & operator* | ( | ) | const |
Dereference Operator.
- Returns
- a reference to the message this is pointing to
🔗operator++()
MsgIter & operator++ | ( | ) |
Copy-assignment operator.
- Parameters
-
[in] _orig the instance being copied
- Returns
- a reference to this instance
Prefix increment
- Returns
- a reference to this instance
🔗operator->()
const Message * operator-> | ( | ) | const |
arrow dereference operator
- Returns
- a pointer to the message this is pointing to
🔗operator=()
Move assignment operator.
- Parameters
-
[in] _other the new iterator replacing the current one
- Returns
- The updated MsgIter.
🔗operator==()
bool operator== | ( | const MsgIter & | _other | ) | const |
Equality operator.
- Parameters
-
[in] _other the iterator this is being compared to
- Returns
- true if the two iterator point to the same message
The documentation for this class was generated from the following file: