TIteratorAdapter | Unreal Engine 5.2 Documentation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Containers

Inheritance Hierarchy

Base
TIteratorAdapter

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Containers/IteratorAdapter.h
Include	#include "Containers/IteratorAdapter.h"

Syntax

template<typename Base>  
class TIteratorAdapter : public Base

Remarks

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();

Constructors

	Type	Name	Description
		TIteratorAdapter ()
		TIteratorAdapter ( EInPlace, Args&&... InArgs )	Perfect forwarding constructor to the iterator class.

Operators

	Type	Name	Description
	ThisType	operator- ( SizeType Offset )
	ThisType	operator-- ( int )
	ThisType &	operator-- ()
	bool	operator!= ( const TIteratorAdapter& Right )
	ElementType &	operator* ()
	ThisType	operator+ ( SizeType Offset )
	ThisType &	operator++ ()
	ThisType	operator++ ( int )
	ThisType &	operator+= ( SizeType Offset )
	ThisType &	operator-= ( SizeType Offset )
	bool	operator== ( const TIteratorAdapter& Right )
	ElementType *	operator-> ()

Typedefs

Name	Description
BaseType
ElementType
SizeType
ThisType

Navigation