WorldIter Class Reference

class for iterating through worlds More...

#include <WorldIter.hh>

Public Member Functions
	WorldIter (WorldIter &&_old)
	Move constructor. More...
	~WorldIter ()
	Default destructor. More...
	operator bool () const
	Conversion operator. More...
	operator WorldIdentifier () const
	Conversion operator. More...
WorldIdentifier &	operator* ()
	Derefence operator. More...
WorldIter &	operator++ ()
	Prefix increment. More...
WorldIdentifier *	operator-> ()
	-> operator More...

Protected Member Functions
	WorldIter (std::unique_ptr< WorldIterPrivate > _dptr)
	Construct an iterator with the data it needs to function. More...

Detailed Description

class for iterating through worlds

Constructor & Destructor Documentation

WorldIter() [1/2]

WorldIter ( std::unique_ptr< WorldIterPrivate >  _dptr )

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 &&

_old

)

Move constructor.

Parameters

[in]

_old

Iter to move

~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:

• WorldIter.hh