Gazebo Fuel_tools

API Reference

4.9.1

class for iterating through models More...

#include <ModelIter.hh>

Public Member Functions

 ModelIter (ModelIter &&_old)
 Move constructor. More...
 
 ~ModelIter ()
 Default destructor. More...
 
 operator bool ()
 Conversion operator. More...
 
 operator bool () const
 Conversion operator. More...
 
Modeloperator* ()
 Dereference operator. More...
 
ModelIteroperator++ ()
 Prefix increment. More...
 
Modeloperator-> ()
 -> operator More...
 

Protected Member Functions

 ModelIter (std::unique_ptr< ModelIterPrivate > _dptr)
 Construct an iterator with the data it needs to function. More...
 

Detailed Description

class for iterating through models

Constructor & Destructor Documentation

◆ ModelIter() [1/2]

ModelIter ( std::unique_ptr< ModelIterPrivate >  _dptr)
explicitprotected

Construct an iterator with the data it needs to function.

Parameters
[in]_dptrPointer to private data to copy

◆ ModelIter() [2/2]

ModelIter ( ModelIter &&  _old)

Move constructor.

Parameters
[in]_oldIter to move

◆ ~ModelIter()

~ModelIter ( )

Default destructor.

Member Function Documentation

◆ operator bool() [1/2]

operator bool ( )

Conversion operator.

Returns
false once the iterator is one past the end of the models

◆ operator bool() [2/2]

operator bool ( ) const

Conversion operator.

Returns
false once the iterator is one past the end of the models

◆ operator*()

Model& operator* ( )

Dereference operator.

Returns
Reference

◆ operator++()

ModelIter& operator++ ( )

Prefix increment.

Returns
Next iteration

◆ operator->()

Model* operator-> ( )

-> operator

Returns
Internal world identifier

The documentation for this class was generated from the following file: