Karma::FUObjectArray::TIterator Class Reference

Low level iterator. More...

#include <UObjectGlobals.h>

Inheritance diagram for Karma::FUObjectArray::TIterator:

Public Types
enum	EEndTagType { EndTag }

Public Member Functions
	TIterator (const FUObjectArray &InArray, bool bOnlyGCedObjects=false)
	TIterator (EEndTagType, const TIterator &InIter)
FORCEINLINE void	operator++ ()
bool	operator== (const TIterator &Rhs) const
bool	operator!= (const TIterator &Rhs) const
FORCEINLINE	operator bool () const
FORCEINLINE bool	operator! () const
FORCEINLINE int32	GetIndex () const

Protected Member Functions
FORCEINLINE FUObjectItem *	GetObject () const
FORCEINLINE bool	Advance ()
const FUObjectArray &	GetIteratedArray () const

Detailed Description

Low level iterator.

Constructor & Destructor Documentation

TIterator() [1/2]

Karma::FUObjectArray::TIterator::TIterator ( const FUObjectArray & InArray, bool bOnlyGCedObjects = false )

inline

Constructor

Parameters

InArray	the array to iterate on
bOnlyGCedObjects	if true, skip all of the permanent objects (not functional)

See also

FRawObjectIterator::FRawObjectIterator() child class, with GUObjectStore for InArray

Todo

Garbage collection may require some changes here

Since

Karma 1.0.0

TIterator() [2/2]

Karma::FUObjectArray::TIterator::TIterator ( EEndTagType , const TIterator & InIter )

inline

Constructor (need to write more)

Parameters

EEndTagType	the array to iterate on
InIter	if true, skip all of the permanent objects

Since

Karma 1.0.0

Member Function Documentation

Advance()

FORCEINLINE bool Karma::FUObjectArray::TIterator::Advance ( )

inlineprotected

Iterator advance with ordinary name for clarity in subclasses.

Remarks

Advances the m_Index by 1, or caches the next UObject* in the supplied array

Returns

true if the iterator points to a valid object, false if iteration is complete

Since

Karma 1.0.0

GetIndex()

FORCEINLINE int32 Karma::FUObjectArray::TIterator::GetIndex ( ) const

inline

Getter for current index

Returns

The current index of the interator

Since

Karma 1.0.0

GetIteratedArray()

const FUObjectArray & Karma::FUObjectArray::TIterator::GetIteratedArray ( ) const

inlineprotected

Gets the array this iterator iterates over

Since

Karma 1.0.0

GetObject()

FORCEINLINE FUObjectItem * Karma::FUObjectArray::TIterator::GetObject ( ) const

inlineprotected

Dereferences the iterator with an ordinary name for clarity in derived classes

Returns

the UObject at the iterator

Since

Karma 1.0.0

operator bool()

FORCEINLINE Karma::FUObjectArray::TIterator::operator bool ( ) const

inlineexplicit

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

Since

Karma 1.0.0

operator!()

FORCEINLINE bool Karma::FUObjectArray::TIterator::operator! ( ) const

inline

inverse of the "bool" operator

Remarks

Need to understand meaning and usage

Since

Karma 1.0.0

operator!=()

bool Karma::FUObjectArray::TIterator::operator!= ( const TIterator & Rhs ) const

inline

Iterator comparison

Since

Karma 1.0.0

operator++()

FORCEINLINE void Karma::FUObjectArray::TIterator::operator++ ( )

inline

Iterator advance, operator overloading

Since

Karma 1.0.0

operator==()

bool Karma::FUObjectArray::TIterator::operator== ( const TIterator & Rhs ) const

inline

Iterator comparison

Since

Karma 1.0.0

---

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

• Karma/src/Karma/Core/UObjectGlobals.h