T2ObjectPool< T, MaxNumber, ObjectSize, Alignment > Class Template Reference

#include <T2ObjectPool.h>

Inheritance diagram for T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >:

Public Member Functions
	TSTATICASSERT (MaxNumber >=2)
	TSTATICASSERT (sizeof(T) >=sizeof(T2GenericObjectPool::UnusedObject))
	T2ObjectPool ()
template<class... Args>
T *	NewObject (Args &&... args)
T *	AllocateObject ()
void	FreeObject (T *a_pObject)
void	DeleteObject (T *a_pObject)
virtual TSIZE	GetUsedSize () const OVERRIDE
virtual TSIZE	GetCapacity () const OVERRIDE
virtual TBOOL	IsAddressInPool (const void *a_pAddress) const
TBOOL	CanAllocate () const

Additional Inherited Members
Protected Member Functions inherited from T2GenericObjectPool
virtual void *	Malloc (TSIZE a_uiSize, TSIZE a_uiAlignment) OVERRIDE
virtual void *	Malloc (TSIZE a_uiSize) OVERRIDE
virtual void	Free (void *a_pPtr) OVERRIDE
virtual TBOOL	CanAllocate (TSIZE size) const OVERRIDE
virtual void *	TryMalloc (TSIZE size, TSIZE alignment) OVERRIDE
virtual void *	TryMalloc (TSIZE size) OVERRIDE
void	Initialise (UnusedObject *a_pObjects, TUINT a_uiMaxNumber, TUINT a_uiObjectSize)
UnusedObject *	GetObject ()
void	ReturnObject (UnusedObject *a_pObject)
TUINT	GetNumFreeObjects () const
virtual	~T2GenericObjectPool ()=default
Protected Member Functions inherited from T2Allocator
template<class T, class... Args>
T *	New (Args &&... args)
template<class T>
void	Delete (T *ptr)
Protected Attributes inherited from T2GenericObjectPool
UnusedObject *	m_pHead

Detailed Description

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>
class T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >

Definition at line 99 of file T2ObjectPool.h.

Constructor & Destructor Documentation

T2ObjectPool()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::T2ObjectPool ( )

inline

Definition at line 106 of file T2ObjectPool.h.

    {
        T2GenericObjectPool::Initialise(
            TREINTERPRETCAST( T2GenericObjectPool::UnusedObject*, GetObjects() ),
            MaxNumber,
            ObjectSize
        );
    }

Member Function Documentation

AllocateObject()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

T * T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::AllocateObject ( )

inline

Definition at line 123 of file T2ObjectPool.h.

    {
        TASSERT( TTRUE == T2GenericObjectPool::CanAllocate( ObjectSize ) );
        return TSTATICCAST( T, Malloc( ObjectSize ) );
    }

CanAllocate()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

TBOOL T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::CanAllocate ( ) const

inline

Definition at line 158 of file T2ObjectPool.h.

{ return T2GenericObjectPool::CanAllocate( ObjectSize ); }

DeleteObject()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

void T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::DeleteObject ( T * a_pObject )

inline

Definition at line 135 of file T2ObjectPool.h.

    {
        TASSERT( TTRUE == IsAddressInPool( a_pObject ) );
        a_pObject->~T();
        Free( a_pObject );
    }

FreeObject()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

void T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::FreeObject ( T * a_pObject )

inline

Definition at line 129 of file T2ObjectPool.h.

    {
        TASSERT( TTRUE == IsAddressInPool( a_pObject ) );
        Free( a_pObject );
    }

GetCapacity()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

virtual TSIZE T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::GetCapacity ( ) const

inlinevirtual

Implements T2Allocator.

Definition at line 147 of file T2ObjectPool.h.

    {
        return MaxNumber * ObjectSize;
    }

GetUsedSize()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

virtual TSIZE T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::GetUsedSize ( ) const

inlinevirtual

Implements T2Allocator.

Definition at line 142 of file T2ObjectPool.h.

    {
        return ( MaxNumber - GetNumFreeObjects() ) * ObjectSize;
    }

IsAddressInPool()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

virtual TBOOL T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::IsAddressInPool ( const void * a_pAddress ) const

inlinevirtual

Definition at line 152 of file T2ObjectPool.h.

    {
        return ( TREINTERPRETCAST( TUINTPTR, this ) + sizeof( T2GenericObjectPool ) ) <= TREINTERPRETCAST( TUINTPTR, a_pAddress ) &&
            TREINTERPRETCAST( TUINTPTR, a_pAddress ) < ( TREINTERPRETCAST( TUINTPTR, this ) + sizeof( T2GenericObjectPool ) + ( MaxNumber * ObjectSize ) );
    }

NewObject()

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

template<class... Args>

T * T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::NewObject ( Args &&... args )

inline

Definition at line 116 of file T2ObjectPool.h.

    {
        TASSERT( TTRUE == T2GenericObjectPool::CanAllocate( ObjectSize ) );
        T* pValue = new ( Malloc( ObjectSize ) ) T( std::forward<Args>( args )... );
        return pValue;
    }

TSTATICASSERT() [1/2]

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::TSTATICASSERT

(

MaxNumber >=

2

)

TSTATICASSERT() [2/2]

template<class T, TUINT MaxNumber, TUINT ObjectSize = sizeof( T ), TUINT Alignment = alignof( T )>

T2ObjectPool< T, MaxNumber, ObjectSize, Alignment >::TSTATICASSERT

(

sizeof(T) >=sizeof(T2GenericObjectPool::UnusedObject)

)

---

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

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Toshi/T2ObjectPool.h