Chaos::Private::TPoolBackedArray< T, TItemAdapter > Class Template Reference

#include <PoolBackedArray.h>

Public Types
using	FItem = T
using	FItemPtr = FItem *
using	FConstItemPtr = const FItem *
using	FItemAdapter = TItemAdapter
using	FRangedForIterator = typename TArray< FItemPtr >::RangedForIteratorType
using	FRangedForConstIterator = typename TArray< FItemPtr >::RangedForConstIteratorType

Public Member Functions
	TPoolBackedArray (const int32 NumItemsPerBlock)
template<typename... TArgs>
FItemPtr	Alloc (TArgs &&... Args)
void	Free (FItemPtr Item)
void	Reset ()
int32	Num () const
bool	IsEmpty () const
void	Reserve (const int32 Size)
FItemPtr	operator[] (const int32 Index)
const FItemPtr	operator[] (const int32 Index) const
FRangedForIterator	begin ()
FRangedForIterator	end ()
FRangedForConstIterator	begin () const
FRangedForConstIterator	end () const
void	SortFreeLists ()

Detailed Description

template<typename T, typename TItemAdapter = TPoolBackedItemAdapter<T>>
class Chaos::Private::TPoolBackedArray< T, TItemAdapter >

An array of (pointers to) Items with items allocated from an ObjectPool. Item pointers are persistent until freed.

Template Parameters

TItemAdapter

Provides the Get/Set methods for array index of each item

Member Typedef Documentation

FConstItemPtr

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

using Chaos::Private::TPoolBackedArray< T, TItemAdapter >::FConstItemPtr = const FItem*

FItem

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

using Chaos::Private::TPoolBackedArray< T, TItemAdapter >::FItem = T

FItemAdapter

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

using Chaos::Private::TPoolBackedArray< T, TItemAdapter >::FItemAdapter = TItemAdapter

FItemPtr

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

using Chaos::Private::TPoolBackedArray< T, TItemAdapter >::FItemPtr = FItem*

FRangedForConstIterator

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

using Chaos::Private::TPoolBackedArray< T, TItemAdapter >::FRangedForConstIterator = typename TArray<FItemPtr>::RangedForConstIteratorType

FRangedForIterator

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

using Chaos::Private::TPoolBackedArray< T, TItemAdapter >::FRangedForIterator = typename TArray<FItemPtr>::RangedForIteratorType

Constructor & Destructor Documentation

TPoolBackedArray()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

Chaos::Private::TPoolBackedArray< T, TItemAdapter >::TPoolBackedArray ( const int32  NumItemsPerBlock )

inline

Member Function Documentation

Alloc()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

template<typename... TArgs>

FItemPtr Chaos::Private::TPoolBackedArray< T, TItemAdapter >::Alloc ( TArgs &&...  Args )

inline

begin() [1/2]

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

FRangedForIterator Chaos::Private::TPoolBackedArray< T, TItemAdapter >::begin ( )

inline

begin() [2/2]

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

FRangedForConstIterator Chaos::Private::TPoolBackedArray< T, TItemAdapter >::begin ( ) const

inline

end() [1/2]

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

FRangedForIterator Chaos::Private::TPoolBackedArray< T, TItemAdapter >::end ( )

inline

end() [2/2]

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

FRangedForConstIterator Chaos::Private::TPoolBackedArray< T, TItemAdapter >::end ( ) const

inline

Free()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

void Chaos::Private::TPoolBackedArray< T, TItemAdapter >::Free ( FItemPtr  Item )

inline

IsEmpty()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

bool Chaos::Private::TPoolBackedArray< T, TItemAdapter >::IsEmpty ( ) const

inline

Num()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

int32 Chaos::Private::TPoolBackedArray< T, TItemAdapter >::Num ( ) const

inline

operator[]() [1/2]

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

FItemPtr Chaos::Private::TPoolBackedArray< T, TItemAdapter >::operator[] ( const int32  Index )

inline

operator[]() [2/2]

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

const FItemPtr Chaos::Private::TPoolBackedArray< T, TItemAdapter >::operator[] ( const int32  Index ) const

inline

Reserve()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

void Chaos::Private::TPoolBackedArray< T, TItemAdapter >::Reserve ( const int32  Size )

inline

Reset()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

void Chaos::Private::TPoolBackedArray< T, TItemAdapter >::Reset ( )

inline

SortFreeLists()

template<typename T , typename TItemAdapter = TPoolBackedItemAdapter<T>>

void Chaos::Private::TPoolBackedArray< T, TItemAdapter >::SortFreeLists ( )

inline

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/PoolBackedArray.h