TSharedBuffer< T, BUFSIZE, IDENTIFIER > Class Template Reference

#include <TSharedBuffer.h>

Classes
class	TNode

Public Member Functions
	TSharedBuffer ()
	~TSharedBuffer ()
TUINT	GetSize () const
TBOOL	SetSize (TINT a_iSize)
T &	At (TINT a_iIndex)
const T &	At (TINT a_iIndex) const
T &	operator[] (TINT a_iIndex)
const T &	operator[] (TINT a_iIndex) const

Static Public Member Functions
static void	CreateSharedBuffers (TINT a_iNumBuffers)
static void	DestroySharedBuffers ()
static TBOOL	IsAnyBuffersUsed ()

Detailed Description

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>
class TSharedBuffer< T, BUFSIZE, IDENTIFIER >

Definition at line 13 of file TSharedBuffer.h.

Constructor & Destructor Documentation

TSharedBuffer()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

TSharedBuffer< T, BUFSIZE, IDENTIFIER >::TSharedBuffer ( )

inline

Definition at line 111 of file TSharedBuffer.h.

        : m_oArray( 4, 10 )
    {
        TASSERT( ( 1 << TMath::IntLog2( BUFSIZE ) ) == BUFSIZE );
    }

~TSharedBuffer()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

TSharedBuffer< T, BUFSIZE, IDENTIFIER >::~TSharedBuffer ( )

inline

Definition at line 117 of file TSharedBuffer.h.

    {
        SetSize( 0 );
    }

Member Function Documentation

At() [1/2]

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

T & TSharedBuffer< T, BUFSIZE, IDENTIFIER >::At ( TINT a_iIndex )

inline

Definition at line 182 of file TSharedBuffer.h.

    {
        TASSERT( TMath::IntLog2( BUFSIZE ) == m_iMainIndexShift );
        TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
        TASSERT( a_iIndex < m_oArray.Size() * BUFSIZE );
 
        TINT iSubIndex  = m_iSubIndexMask & a_iIndex;
        TINT iMainIndex = a_iIndex >> ( m_iMainIndexShift % BUFSIZE );
 
        TASSERT( iMainIndex < m_oArray.Size() );
        TASSERT( iSubIndex < BUFSIZE );
 
        return m_oArray[ iMainIndex ]->GetElement( iSubIndex );
    }

At() [2/2]

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

const T & TSharedBuffer< T, BUFSIZE, IDENTIFIER >::At ( TINT a_iIndex ) const

inline

Definition at line 197 of file TSharedBuffer.h.

    {
        TASSERT( TMath::IntLog2( BUFSIZE ) == m_iMainIndexShift );
        TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
        TASSERT( a_iIndex < m_oArray.Size() * BUFSIZE );
 
        TINT iSubIndex  = m_iSubIndexMask & a_iIndex;
        TINT iMainIndex = a_iIndex >> ( m_iMainIndexShift % BUFSIZE );
 
        TASSERT( iMainIndex < m_oArray.Size() );
        TASSERT( iSubIndex < BUFSIZE );
 
        return m_oArray[ iMainIndex ]->GetElement( iSubIndex );
    }

CreateSharedBuffers()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

static void TSharedBuffer< T, BUFSIZE, IDENTIFIER >::CreateSharedBuffers ( TINT a_iNumBuffers )

inlinestatic

Definition at line 53 of file TSharedBuffer.h.

    {
        TASSERT( m_iNumBuffers == 0 );
        TASSERT( m_pNodeArray == TNULL );
 
        m_iNumBuffers = a_iNumBuffers;
 
        if ( a_iNumBuffers > m_oFreeList.SizeAllocated() )
        {
            m_oFreeList.Resize( a_iNumBuffers );
        }
 
        m_oFreeList.SetSize( a_iNumBuffers );
        m_pNodeArray = TSTATICCAST( TNode, TMalloc( sizeof( TNode ) * m_iNumBuffers ) );
 
        for ( TINT i = 0; i < m_iNumBuffers; i++ )
        {
            m_oFreeList[ i ] = &m_pNodeArray[ i ];
        }
 
        TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
        TASSERT( ( 1 << TMath::IntLog2( BUFSIZE ) ) == BUFSIZE );
 
        m_iMainIndexShift = TMath::IntLog2( BUFSIZE );
        m_iSubIndexMask   = ( 1 << TMath::IntLog2( BUFSIZE ) ) - 1;
    }

DestroySharedBuffers()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

static void TSharedBuffer< T, BUFSIZE, IDENTIFIER >::DestroySharedBuffers ( )

inlinestatic

Definition at line 80 of file TSharedBuffer.h.

    {
        TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
        TASSERT( TFALSE == IsAnyBuffersUsed() );
 
        m_oFreeList.Clear();
 
        TVALIDPTR( m_pNodeArray );
        TFree( m_pNodeArray );
 
        m_iNumBuffers = 0;
        m_pNodeArray  = TNULL;
    }

GetSize()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

TUINT TSharedBuffer< T, BUFSIZE, IDENTIFIER >::GetSize ( ) const

inline

Definition at line 122 of file TSharedBuffer.h.

    {
        return m_oArray.Size() << m_iMainIndexShift;
    }

IsAnyBuffersUsed()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

static TBOOL TSharedBuffer< T, BUFSIZE, IDENTIFIER >::IsAnyBuffersUsed ( )

inlinestatic

Definition at line 94 of file TSharedBuffer.h.

    {
        return m_iNumBuffers != m_oFreeList.Size();
    }

operator[]() [1/2]

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

T & TSharedBuffer< T, BUFSIZE, IDENTIFIER >::operator[] ( TINT a_iIndex )

inline

Definition at line 212 of file TSharedBuffer.h.

    {
        return At( a_iIndex );
    }

operator[]() [2/2]

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

const T & TSharedBuffer< T, BUFSIZE, IDENTIFIER >::operator[] ( TINT a_iIndex ) const

inline

Definition at line 217 of file TSharedBuffer.h.

    {
        return At( a_iIndex );
    }

SetSize()

template<typename T, TINT BUFSIZE, TINT IDENTIFIER>

TBOOL TSharedBuffer< T, BUFSIZE, IDENTIFIER >::SetSize ( TINT a_iSize )

inline

Definition at line 127 of file TSharedBuffer.h.

    {
        TASSERT( a_iSize >= 0 );
        TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
        TASSERT( TMath::IntLog2( BUFSIZE ) == m_iMainIndexShift );
 
        TINT iDesiredNumNodes = a_iSize >> ( m_iMainIndexShift % BUFSIZE );
 
        if ( 0 < ( m_iSubIndexMask & a_iSize ) )
        {
            iDesiredNumNodes += 1;
        }
 
        TASSERT( iDesiredNumNodes >= 0 );
 
        if ( m_oArray.Size() != iDesiredNumNodes )
        {
            if ( 10 < iDesiredNumNodes ) return TFALSE;
 
            if ( iDesiredNumNodes < m_oArray.Size() )
            {
                // Removing elements from m_oArray
 
                while ( iDesiredNumNodes < m_oArray.Size() )
                {
                    // Remove the last element from array and store in the freelist
                    m_oFreeList.Push( m_oArray.Pop() );
                }
 
                TASSERT( m_oArray.Size() == iDesiredNumNodes );
                TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
            }
            else
            {
                // Adding new elements to m_oArray
 
                if ( m_oFreeList.Size() < 1 ) return TFALSE;
 
                while ( m_oArray.Size() < iDesiredNumNodes )
                {
                    if ( m_oFreeList.Size() < 1 ) return TFALSE;
 
                    TASSERT( m_oArray.Size() < m_oArray.SizeAllocated() );
 
                    m_oArray.Push( m_oFreeList.Pop() );
                }
 
                TASSERT( m_oArray.Size() == iDesiredNumNodes );
                TASSERT( m_oFreeList.Size() <= m_iNumBuffers );
            }
        }
 
        return TTRUE;
    }

---

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

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