UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TConstSetBitIterator< Allocator > Class Template Reference

#include <BitArray.h>

+ Inheritance diagram for TConstSetBitIterator< Allocator >:

Public Member Functions

 TConstSetBitIterator (const TBitArray< Allocator > &InArray UE_LIFETIMEBOUND)
 
 TConstSetBitIterator (const TBitArray< Allocator > &InArray UE_LIFETIMEBOUND, int32 StartIndex)
 
UE_FORCEINLINE_HINT TConstSetBitIteratoroperator++ ()
 
UE_FORCEINLINE_HINT bool operator== (const TConstSetBitIterator &Rhs) const
 
UE_FORCEINLINE_HINT bool operator!= (const TConstSetBitIterator &Rhs) const
 
UE_FORCEINLINE_HINT operator bool () const
 
UE_FORCEINLINE_HINT bool operator! () const
 
UE_FORCEINLINE_HINT int32 GetIndex () const
 
- Public Member Functions inherited from FRelativeBitReference
UE_FORCEINLINE_HINT FRelativeBitReference (int32 BitIndex)
 
UE_FORCEINLINE_HINT bool operator== (FRelativeBitReference Other) const
 
UE_FORCEINLINE_HINT bool operator!= (FRelativeBitReference Other) const
 

Additional Inherited Members

- Public Attributes inherited from FRelativeBitReference
int32 WordIndex
 
uint32 Mask
 

Detailed Description

template<typename Allocator>
class TConstSetBitIterator< Allocator >

An iterator which only iterates over set bits.

Constructor & Destructor Documentation

◆ TConstSetBitIterator() [1/2]

template<typename Allocator >
TConstSetBitIterator< Allocator >::TConstSetBitIterator ( const TBitArray< Allocator > &InArray  UE_LIFETIMEBOUND)
inlineexplicit

◆ TConstSetBitIterator() [2/2]

template<typename Allocator >
TConstSetBitIterator< Allocator >::TConstSetBitIterator ( const TBitArray< Allocator > &InArray  UE_LIFETIMEBOUND,
int32  StartIndex 
)
inlineexplicit

Member Function Documentation

◆ GetIndex()

template<typename Allocator >
UE_FORCEINLINE_HINT int32 TConstSetBitIterator< Allocator >::GetIndex ( ) const
inline

Index accessor.

◆ operator bool()

template<typename Allocator >
UE_FORCEINLINE_HINT TConstSetBitIterator< Allocator >::operator bool ( ) const
inlineexplicit

conversion to "bool" returning true if the iterator is valid.

◆ operator!()

template<typename Allocator >
UE_FORCEINLINE_HINT bool TConstSetBitIterator< Allocator >::operator! ( ) const
inline

inverse of the "bool" operator

◆ operator!=()

◆ operator++()

Forwards iteration operator.

◆ operator==()

template<typename Allocator >
UE_FORCEINLINE_HINT bool TConstSetBitIterator< Allocator >::operator== ( const TConstSetBitIterator< Allocator > &  Rhs) const
inline

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