T2DynamicObjectPool< T > Class Template Reference

#include <T2ObjectPool.h>

Inheritance diagram for T2DynamicObjectPool< T >:

Public Member Functions
	T2DynamicObjectPool (T2Allocator *a_pAllocator, TINT a_iMaxNumber, TSIZE a_uiSize=sizeof(T), TSIZE a_uiAlignment=alignof(T))
virtual	~T2DynamicObjectPool ()
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>
class T2DynamicObjectPool< T >

Definition at line 176 of file T2ObjectPool.h.

Constructor & Destructor Documentation

T2DynamicObjectPool()

template<class T>

T2DynamicObjectPool< T >::T2DynamicObjectPool ( T2Allocator * a_pAllocator, TINT a_iMaxNumber, TSIZE a_uiSize = sizeof( T ), TSIZE a_uiAlignment = alignof( T ) )

inline

Definition at line 179 of file T2ObjectPool.h.

    {
        TVALIDPTR( a_pAllocator );
        m_iMaxNumber = a_iMaxNumber;
        m_pAllocator = a_pAllocator;
 
        TUINT32 uiClassSize      = a_uiSize;
        TUINT32 uiClassAlignment = a_uiAlignment;
        m_uiObjectSize           = ( uiClassSize - 1 ) + uiClassAlignment & ~( uiClassAlignment - 1U );
 
        TASSERT( m_uiObjectSize >= a_uiSize && uiClassAlignment > 0 );
 
        if ( m_iMaxNumber < 1 )
        {
            m_pData = TNULL;
        }
        else
        {
            m_pData = m_pAllocator->Malloc( m_iMaxNumber * m_uiObjectSize, uiClassAlignment );
        }
 
        TVALIDPTR( m_pData );
        T2GenericObjectPool::Initialise(
            TREINTERPRETCAST( T2GenericObjectPool::UnusedObject*, m_pData ),
            m_iMaxNumber,
            m_uiObjectSize
        );
    }

~T2DynamicObjectPool()

template<class T>

virtual T2DynamicObjectPool< T >::~T2DynamicObjectPool ( )

inlinevirtual

Definition at line 208 of file T2ObjectPool.h.

    {
        m_pAllocator->Free( m_pData );
    }

Member Function Documentation

AllocateObject()

template<class T>

T * T2DynamicObjectPool< T >::AllocateObject ( )

inline

Definition at line 221 of file T2ObjectPool.h.

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

CanAllocate()

template<class T>

TBOOL T2DynamicObjectPool< T >::CanAllocate ( ) const

inline

Definition at line 256 of file T2ObjectPool.h.

{ return T2GenericObjectPool::CanAllocate( m_uiObjectSize ); }

DeleteObject()

template<class T>

void T2DynamicObjectPool< T >::DeleteObject ( T * a_pObject )

inline

Definition at line 233 of file T2ObjectPool.h.

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

FreeObject()

template<class T>

void T2DynamicObjectPool< T >::FreeObject ( T * a_pObject )

inline

Definition at line 227 of file T2ObjectPool.h.

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

GetCapacity()

template<class T>

virtual TSIZE T2DynamicObjectPool< T >::GetCapacity ( ) const

inlinevirtual

Implements T2Allocator.

Definition at line 245 of file T2ObjectPool.h.

    {
        return m_iMaxNumber * m_uiObjectSize;
    }

GetUsedSize()

template<class T>

virtual TSIZE T2DynamicObjectPool< T >::GetUsedSize ( ) const

inlinevirtual

Implements T2Allocator.

Definition at line 240 of file T2ObjectPool.h.

    {
        return ( m_iMaxNumber - GetNumFreeObjects() ) * m_uiObjectSize;
    }

IsAddressInPool()

template<class T>

virtual TBOOL T2DynamicObjectPool< T >::IsAddressInPool ( const void * a_pAddress ) const

inlinevirtual

Definition at line 250 of file T2ObjectPool.h.

    {
        return TREINTERPRETCAST( TUINTPTR, m_pData ) <= TREINTERPRETCAST( TUINTPTR, a_pAddress ) &&
            TREINTERPRETCAST( TUINTPTR, a_pAddress ) < TREINTERPRETCAST( TUINTPTR, m_pData ) + ( m_iMaxNumber * m_uiObjectSize );
    }

NewObject()

template<class T>

template<class... Args>

T * T2DynamicObjectPool< T >::NewObject ( Args &&... args )

inline

Definition at line 214 of file T2ObjectPool.h.

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

---

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

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