WorldIter Class Reference
class for iterating through worlds More...
#include <WorldIter.hh>
Public Member Functions | |
WorldIter (WorldIter &&_old) | |
Move constructor. | |
~WorldIter () | |
Default destructor. | |
operator bool () const | |
Conversion operator. | |
operator WorldIdentifier () const | |
Conversion operator. | |
WorldIdentifier & | operator* () |
Derefence operator. | |
WorldIter & | operator++ () |
Prefix increment. | |
WorldIdentifier * | operator-> () |
-> operator | |
Protected Member Functions | |
WorldIter (std::unique_ptr< WorldIterPrivate > _dptr) | |
Construct an iterator with the data it needs to function. | |
Detailed Description
class for iterating through worlds
Constructor & Destructor Documentation
◆ WorldIter() [1/2]
|
explicitprotected |
Construct an iterator with the data it needs to function.
- Parameters
-
[in] _dptr Pointer to private data to copy
◆ WorldIter() [2/2]
◆ ~WorldIter()
~WorldIter | ( | ) |
Default destructor.
Member Function Documentation
◆ operator bool()
operator bool | ( | ) | const |
Conversion operator.
- Returns
- False once the iterator is one past the end of the worlds
◆ operator WorldIdentifier()
operator WorldIdentifier | ( | ) | const |
Conversion operator.
- Returns
- Internal world identifier.
◆ operator*()
WorldIdentifier & operator* | ( | ) |
Derefence operator.
- Returns
- Internal world identifier
◆ operator++()
WorldIter & operator++ | ( | ) |
Prefix increment.
- Returns
- Next iteration
◆ operator->()
WorldIdentifier * operator-> | ( | ) |
-> operator
- Returns
- Internal world identifier
The documentation for this class was generated from the following file: