Navigation
API > API/Runtime > API/Runtime/Core
Adapter class for iterator implementation.
This class provides an interface to implement UE compatible iterators with a minimum set of implementation requirements. This provides the user with an easier way to implement custom iterators. The adapter uses a CRTP pattern requiring its base class to implement the following:
Types:
- ElementType: the element type used in the container.
- SizeType: the type use for the container's element indexing and iterator's offset. Methods:
- bool Equals(const IteratorType& other)
- ElementType& Dereference() const;
- void Increment(); Optional:
- void Decrement();
| Name | TIteratorAdapter |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Containers/IteratorAdapter.h |
| Include Path | #include "Containers/IteratorAdapter.h" |
Syntax
template<typename Base>
class TIteratorAdapter : public Base
Inheritance Hierarchy
- Base → TIteratorAdapter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Containers/IteratorAdapter.h | |||
TIteratorAdapter
(
EInPlace, |
Perfect forwarding constructor to the iterator class. | Containers/IteratorAdapter.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BaseType | Base | Containers/IteratorAdapter.h | |
| ElementType | typename BaseType::ElementType | Containers/IteratorAdapter.h | |
| SizeType | typename BaseType::SizeType | Containers/IteratorAdapter.h | |
| ThisType | TIteratorAdapter< Base > | Containers/IteratorAdapter.h |
Functions
Public
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ThisType operator-
(
SizeType Offset |
Containers/IteratorAdapter.h | ||
ThisType operator--
(
int |
Containers/IteratorAdapter.h | ||
ThisType & operator--() |
Containers/IteratorAdapter.h | ||
bool operator!=
(
const TIteratorAdapter& Right |
Containers/IteratorAdapter.h | ||
ElementType & operator*() |
Containers/IteratorAdapter.h | ||
ThisType operator+
(
SizeType Offset |
Containers/IteratorAdapter.h | ||
ThisType & operator++() |
Containers/IteratorAdapter.h | ||
ThisType operator++
(
int |
Containers/IteratorAdapter.h | ||
ThisType & operator+=
(
SizeType Offset |
Containers/IteratorAdapter.h | ||
ThisType & operator-=
(
SizeType Offset |
Containers/IteratorAdapter.h | ||
bool operator==
(
const TIteratorAdapter& Right |
Containers/IteratorAdapter.h | ||
ElementType * operator->() |
Containers/IteratorAdapter.h |