MsgIter Class Reference
Implements iterator for reading messages. More...
#include <MsgIter.hh>
Public Member Functions | |
| MsgIter () | |
| Default constructor. More... | |
| MsgIter (MsgIter &&_orig) | |
| Copy Constructor. More... | |
| ~MsgIter () | |
| Destructor;. More... | |
| bool | operator!= (const MsgIter &_other) const |
| Inequality operator. More... | |
| const Message & | operator* () const |
| Dereference Operator. More... | |
| MsgIter & | operator++ () |
| Copy-assignment operator. More... | |
| const Message * | operator-> () const |
| arrow dereference operator More... | |
| MsgIter & | operator= (MsgIter &&_other) |
| Move assignement operator. More... | |
| bool | operator== (const MsgIter &_other) const |
| Postfix increment. More... | |
Public Attributes | |
| std::unique_ptr< MsgIterPrivate > | dataPtr |
| Private Implementation Pointer. More... | |
Detailed Description
Implements iterator for reading messages.
Constructor & Destructor Documentation
◆ MsgIter() [1/2]
| MsgIter | ( | ) |
Default constructor.
◆ MsgIter() [2/2]
Copy Constructor.
- Parameters
-
[in] _orig the instance being copied Move Constructor [in] _orig the instance being copied
◆ ~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
- 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 assignement operator.
- Parameters
-
[in] _other the new iterator replacing the current one
- Returns
- The updated MsgIter.
◆ operator==()
| bool operator== | ( | const MsgIter & | _other | ) | const |
Postfix increment.
- Returns
- a reference to a copy of this iterator before incrementing Equality operator
- Parameters
-
[in] _other the iterator this is being compared to
- Returns
- true if the two iterator point to the same message
Member Data Documentation
◆ dataPtr
| std::unique_ptr<MsgIterPrivate> dataPtr |
Private Implementation Pointer.
The documentation for this class was generated from the following file: