OpenTTD Source 20261112-master-gbcbec5e63f
TileIteratorWrapper< Titer > Class Template Reference

Tile iterator wrapper. More...

#include <tilearea_wrapper.h>

Data Structures

struct  dereference_visitor
 Visitor to call the underlying tile iterator's dereference operator. More...
struct  increment_visitor
 Visitor to call the underlying tile iterator's increment operator. More...

Public Types

using value_type = TileIndex
 value_type iterator trait
using difference_type = std::ptrdiff_t
 difference_type iterator trait
using iterator_category = std::forward_iterator_tag
 iterator_category iterator trait
using pointer = void
 pointer iterator trait
using reference = void
 reference iterator trait

Public Member Functions

 TileIteratorWrapper (const TileIterator auto &iter)
 Construct the iterator wrapper.
 TileIteratorWrapper (TileIterator auto &&iter)
 Construct the iterator wrapper.
bool operator== (const TileIteratorWrapper &other) const
 Compare with other iterator.
bool operator== (const std::default_sentinel_t &) const
 Compare with end sentinel.
TileIndex operator* () const
 Get the current tile.
TileIteratorWrapper & operator++ ()
 Increment the iterator and set it to the next position.

Private Attributes

std::variant< Titer... > iter
 The underlying iterator.

Detailed Description

template<TileIterator... Titer>
class TileIteratorWrapper< Titer >

Tile iterator wrapper.

Template Parameters
TiterTile iterator types this wrapper supports.

Definition at line 29 of file tilearea_wrapper.h.

Member Typedef Documentation

◆ difference_type

template<TileIterator... Titer>
using TileIteratorWrapper< Titer >::difference_type = std::ptrdiff_t

difference_type iterator trait

Definition at line 32 of file tilearea_wrapper.h.

◆ iterator_category

template<TileIterator... Titer>
using TileIteratorWrapper< Titer >::iterator_category = std::forward_iterator_tag

iterator_category iterator trait

Definition at line 33 of file tilearea_wrapper.h.

◆ pointer

template<TileIterator... Titer>
using TileIteratorWrapper< Titer >::pointer = void

pointer iterator trait

Definition at line 34 of file tilearea_wrapper.h.

◆ reference

template<TileIterator... Titer>
using TileIteratorWrapper< Titer >::reference = void

reference iterator trait

Definition at line 35 of file tilearea_wrapper.h.

◆ value_type

template<TileIterator... Titer>
using TileIteratorWrapper< Titer >::value_type = TileIndex

value_type iterator trait

Definition at line 31 of file tilearea_wrapper.h.

Constructor & Destructor Documentation

◆ TileIteratorWrapper() [1/2]

template<TileIterator... Titer>
TileIteratorWrapper< Titer >::TileIteratorWrapper ( const TileIterator auto & iter)
inline

Construct the iterator wrapper.

Parameters
iterThe underlying iterator.

Definition at line 41 of file tilearea_wrapper.h.

◆ TileIteratorWrapper() [2/2]

template<TileIterator... Titer>
TileIteratorWrapper< Titer >::TileIteratorWrapper ( TileIterator auto && iter)
inline

Construct the iterator wrapper.

Parameters
iterThe underlying iterator.

Definition at line 47 of file tilearea_wrapper.h.

Member Function Documentation

◆ operator*()

template<TileIterator... Titer>
TileIndex TileIteratorWrapper< Titer >::operator* ( ) const
inline

Get the current tile.

Returns
The current tile, or INVALID_TILE when complete.

Definition at line 72 of file tilearea_wrapper.h.

◆ operator++()

template<TileIterator... Titer>
TileIteratorWrapper & TileIteratorWrapper< Titer >::operator++ ( )
inline

Increment the iterator and set it to the next position.

Returns
This iterator after incrementing.

Definition at line 81 of file tilearea_wrapper.h.

◆ operator==() [1/2]

template<TileIterator... Titer>
bool TileIteratorWrapper< Titer >::operator== ( const std::default_sentinel_t & ) const
inline

Compare with end sentinel.

Returns
true iff this iterator is at the end.

Definition at line 63 of file tilearea_wrapper.h.

◆ operator==() [2/2]

template<TileIterator... Titer>
bool TileIteratorWrapper< Titer >::operator== ( const TileIteratorWrapper< Titer > & other) const
inline

Compare with other iterator.

Parameters
otherThe other iterator to compare with.
Returns
true iff the other iterator matches this value.

Definition at line 54 of file tilearea_wrapper.h.

Field Documentation

◆ iter


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