TRingBufferIterator< ContainerType, ElementType, SizeType > Class Template Reference

#include <RingBuffer.h>

Public Member Functions
	TRingBufferIterator (ContainerType &InContainer, SizeType StartIndex=0)
TRingBufferIterator &	operator++ ()
TRingBufferIterator	operator++ (int)
TRingBufferIterator &	operator-- ()
TRingBufferIterator	operator-- (int)
TRingBufferIterator &	operator+= (SizeType Offset)
TRingBufferIterator	operator+ (SizeType Offset) const
TRingBufferIterator &	operator-= (SizeType Offset)
TRingBufferIterator	operator- (SizeType Offset) const
UE_FORCEINLINE_HINT ElementType &	operator* () const
UE_FORCEINLINE_HINT ElementType *	operator-> () const
UE_FORCEINLINE_HINT	operator bool () const
SizeType	GetIndex () const
void	Reset ()
void	SetToEnd ()
void	RemoveCurrent ()
UE_FORCEINLINE_HINT bool	operator== (const TRingBufferIterator &Rhs) const
UE_FORCEINLINE_HINT bool	operator!= (const TRingBufferIterator &Rhs) const

Constructor & Destructor Documentation

TRingBufferIterator()

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator< ContainerType, ElementType, SizeType >::TRingBufferIterator ( ContainerType &  InContainer, SizeType  StartIndex = 0  )

inline

Member Function Documentation

GetIndex()

template<typename ContainerType , typename ElementType , typename SizeType >

SizeType TRingBufferIterator< ContainerType, ElementType, SizeType >::GetIndex ( ) const

inline

Returns an index to the current element.

operator bool()

template<typename ContainerType , typename ElementType , typename SizeType >

UE_FORCEINLINE_HINT TRingBufferIterator< ContainerType, ElementType, SizeType >::operator bool ( ) const

inlineexplicit

conversion to "bool" returning true if the iterator has not reached the last element.

operator!=()

template<typename ContainerType , typename ElementType , typename SizeType >

UE_FORCEINLINE_HINT bool TRingBufferIterator< ContainerType, ElementType, SizeType >::operator!= ( const TRingBufferIterator< ContainerType, ElementType, SizeType > &  Rhs ) const

inline

operator*()

template<typename ContainerType , typename ElementType , typename SizeType >

UE_FORCEINLINE_HINT ElementType & TRingBufferIterator< ContainerType, ElementType, SizeType >::operator* ( ) const

inline

operator+()

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator TRingBufferIterator< ContainerType, ElementType, SizeType >::operator+ ( SizeType  Offset ) const

inline

operator++() [1/2]

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator & TRingBufferIterator< ContainerType, ElementType, SizeType >::operator++ ( )

inline

Advances iterator to the next element in the container.

operator++() [2/2]

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator TRingBufferIterator< ContainerType, ElementType, SizeType >::operator++ ( int  )

inline

operator+=()

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator & TRingBufferIterator< ContainerType, ElementType, SizeType >::operator+= ( SizeType  Offset )

inline

iterator arithmetic support

operator-()

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator TRingBufferIterator< ContainerType, ElementType, SizeType >::operator- ( SizeType  Offset ) const

inline

operator--() [1/2]

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator & TRingBufferIterator< ContainerType, ElementType, SizeType >::operator-- ( )

inline

Moves iterator to the previous element in the container.

operator--() [2/2]

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator TRingBufferIterator< ContainerType, ElementType, SizeType >::operator-- ( int  )

inline

operator-=()

template<typename ContainerType , typename ElementType , typename SizeType >

TRingBufferIterator & TRingBufferIterator< ContainerType, ElementType, SizeType >::operator-= ( SizeType  Offset )

inline

operator->()

template<typename ContainerType , typename ElementType , typename SizeType >

UE_FORCEINLINE_HINT ElementType * TRingBufferIterator< ContainerType, ElementType, SizeType >::operator-> ( ) const

inline

operator==()

template<typename ContainerType , typename ElementType , typename SizeType >

UE_FORCEINLINE_HINT bool TRingBufferIterator< ContainerType, ElementType, SizeType >::operator== ( const TRingBufferIterator< ContainerType, ElementType, SizeType > &  Rhs ) const

inline

RemoveCurrent()

template<typename ContainerType , typename ElementType , typename SizeType >

void TRingBufferIterator< ContainerType, ElementType, SizeType >::RemoveCurrent ( )

inline

Removes current element in array. This invalidates the current iterator value and it must be incremented

Reset()

template<typename ContainerType , typename ElementType , typename SizeType >

void TRingBufferIterator< ContainerType, ElementType, SizeType >::Reset ( )

inline

Resets the iterator to the first element.

SetToEnd()

template<typename ContainerType , typename ElementType , typename SizeType >

void TRingBufferIterator< ContainerType, ElementType, SizeType >::SetToEnd ( )

inline

Sets the iterator to one past the last element.

---

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

• Engine/Source/Runtime/Core/Public/Containers/RingBuffer.h