Gazebo Transport

API Reference

8.5.0

Implements iterator for reading messages. More...

#include <MsgIter.hh>

Public Member Functions

 MsgIter ()
 Default constructor. More...
 
 MsgIter (MsgIter &&_orig)
 Move Constructor. More...
 
 ~MsgIter ()
 Destructor;. More...
 
bool operator!= (const MsgIter &_other) const
 Inequality operator. More...
 
const Messageoperator* () const
 Dereference Operator. More...
 
MsgIteroperator++ ()
 Copy-assignment operator. More...
 
const Messageoperator-> () const
 arrow dereference operator More...
 
MsgIteroperator= (MsgIter &&_other)
 Move assignement operator. More...
 
bool operator== (const MsgIter &_other) const
 Equality operator. 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]

MsgIter ( MsgIter &&  _orig)

Move Constructor.

Parameters
[in]_origthe instance being copied

◆ ~MsgIter()

~MsgIter ( )

Destructor;.

Member Function Documentation

◆ operator!=()

bool operator!= ( const MsgIter _other) const

Inequality operator.

Parameters
[in]_otherthe 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]_origthe 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=()

MsgIter& operator= ( MsgIter &&  _other)

Move assignement operator.

Parameters
[in]_otherthe new iterator replacing the current one
Returns
The updated MsgIter.

◆ operator==()

bool operator== ( const MsgIter _other) const

Equality operator.

Parameters
[in]_otherthe 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: