ATL::CAtlArray< E, ETraits > Class Template Reference

#include <atlcoll.h>

Public Types
typedef ETraits::INARGTYPE	INARGTYPE
typedef ETraits::OUTARGTYPE	OUTARGTYPE

Public Member Functions
	CAtlArray ()
	~CAtlArray ()
size_t	Add (INARGTYPE element)
size_t	Add ()
bool	SetCount (size_t nNewSize, int nGrowBy=- 1)
size_t	GetCount () const
E &	operator[] (size_t ielement)
const E &	operator[] (size_t ielement) const
E &	GetAt (size_t iElement)
const E &	GetAt (size_t iElement) const
E *	GetData ()
const E *	GetData () const

Private Member Functions
void	CreateItems (E *pData, size_t Size)
void	DestructItems (E *pData, size_t Size)
bool	GrowAllocatedData (size_t nNewSize)
	CAtlArray (_In_ const CAtlArray &)
CAtlArray &	operator= (_In_ const CAtlArray &)

Private Attributes
E *	m_pData
size_t	m_Size
size_t	m_AllocatedSize
size_t	m_GrowBy

Detailed Description

template<typename E, class ETraits = CElementTraits<E>>
class ATL::CAtlArray< E, ETraits >

Definition at line 172 of file atlcoll.h.

Member Typedef Documentation

INARGTYPE

template<typename E , class ETraits = CElementTraits<E>>

typedef ETraits::INARGTYPE ATL::CAtlArray< E, ETraits >::INARGTYPE

Definition at line 175 of file atlcoll.h.

OUTARGTYPE

template<typename E , class ETraits = CElementTraits<E>>

typedef ETraits::OUTARGTYPE ATL::CAtlArray< E, ETraits >::OUTARGTYPE

Definition at line 176 of file atlcoll.h.

Constructor & Destructor Documentation

CAtlArray() [1/2]

template<typename E , class ETraits = CElementTraits<E>>

ATL::CAtlArray< E, ETraits >::CAtlArray ( _In_ const CAtlArray< E, ETraits > &  )

private

CAtlArray() [2/2]

template<typename E , class ETraits >

ATL::CAtlArray< E, ETraits >::CAtlArray

Definition at line 276 of file atlcoll.h.

    : m_pData(NULL)
    , m_Size(0)
    , m_AllocatedSize(0)
    , m_GrowBy(0)
{
}

~CAtlArray()

template<typename E , class ETraits >

ATL::CAtlArray< E, ETraits >::~CAtlArray

Definition at line 285 of file atlcoll.h.

{
    // Destroy all items
    SetCount(0, -1);
}

Member Function Documentation

Add() [1/2]

template<typename E , class ETraits >

size_t ATL::CAtlArray< E, ETraits >::Add

Definition at line 314 of file atlcoll.h.

{
    if (!SetCount(m_Size + 1))
    {
        AtlThrow(E_OUTOFMEMORY);
    }
 
    return m_Size - 1;
}

Add() [2/2]

template<typename E , class ETraits >

size_t ATL::CAtlArray< E, ETraits >::Add

(

INARGTYPE

element

)

Definition at line 295 of file atlcoll.h.

{
    if (m_Size >= m_AllocatedSize)
    {
        if (!GrowAllocatedData(m_Size + 1))
        {
            AtlThrow(E_OUTOFMEMORY);
        }
    }
 
    ::new (m_pData + m_Size) E(element);
    m_Size++;
 
    return m_Size - 1;
}

Referenced by CFontExt::Drop(), and START_TEST().

CreateItems()

template<typename E , class ETraits = CElementTraits<E>>

void ATL::CAtlArray< E, ETraits >::CreateItems ( E *  pData, size_t  Size  )

inlineprivate

Definition at line 188 of file atlcoll.h.

    {
        for (size_t n = 0; n < Size; ++n)
        {
            ::new (pData + n) E;
        }
    }

DestructItems()

template<typename E , class ETraits = CElementTraits<E>>

void ATL::CAtlArray< E, ETraits >::DestructItems ( E *  pData, size_t  Size  )

inlineprivate

Definition at line 198 of file atlcoll.h.

    {
        for (size_t n = 0; n < Size; ++n)
        {
            pData[n].~E();
        }
    }

GetAt() [1/2]

template<typename E , class ETraits >

E & ATL::CAtlArray< E, ETraits >::GetAt

(

size_t

iElement

)

Definition at line 395 of file atlcoll.h.

{
    ATLASSERT(iElement < m_Size);
 
    return m_pData[iElement];
}

Referenced by START_TEST().

GetAt() [2/2]

template<typename E , class ETraits >

const E & ATL::CAtlArray< E, ETraits >::GetAt

(

size_t

iElement

)

const

Definition at line 403 of file atlcoll.h.

{
    ATLASSERT(iElement < m_Size);
 
    return m_pData[iElement];
}

GetCount()

template<typename E , class ETraits >

size_t ATL::CAtlArray< E, ETraits >::GetCount

Definition at line 373 of file atlcoll.h.

{
    return m_Size;
}

Referenced by CFontExt::Drop(), and START_TEST().

GetData() [1/2]

template<typename E , class ETraits >

E * ATL::CAtlArray< E, ETraits >::GetData

Definition at line 411 of file atlcoll.h.

{
    return m_pData;
}

GetData() [2/2]

template<typename E , class ETraits >

const E * ATL::CAtlArray< E, ETraits >::GetData

Definition at line 417 of file atlcoll.h.

{
    return m_pData;
}

GrowAllocatedData()

template<typename E , class ETraits = CElementTraits<E>>

bool ATL::CAtlArray< E, ETraits >::GrowAllocatedData ( size_t  nNewSize )

inlineprivate

Definition at line 206 of file atlcoll.h.

    {
        if (m_pData)
        {
            size_t addSize = m_GrowBy > 0 ? m_GrowBy : m_AllocatedSize / 2;
            size_t allocSize = m_AllocatedSize + addSize;
            if (allocSize < nNewSize)
                allocSize = nNewSize;
 
            E* pData = (E*)malloc(nNewSize * sizeof(E));
 
            if (pData == NULL)
            {
                return false;
            }
 
            // Copy the objects over (default implementation will just move them without calling anything
            ETraits::RelocateElements(pData, m_pData, m_Size);
 
            free(m_pData);
            m_pData = pData;
            m_AllocatedSize = nNewSize;
        }
        else
        {
            // We need to allocate a new buffer
            size_t allocSize = m_GrowBy > nNewSize ? m_GrowBy : nNewSize;
            m_pData = (E*)malloc(allocSize * sizeof(E));
            if (m_pData == NULL)
            {
                return false;
            }
            m_AllocatedSize = allocSize;
        }
        return true;
    }

operator=()

template<typename E , class ETraits = CElementTraits<E>>

CAtlArray & ATL::CAtlArray< E, ETraits >::operator= ( _In_ const CAtlArray< E, ETraits > &  )

private

operator[]() [1/2]

template<typename E , class ETraits >

E & ATL::CAtlArray< E, ETraits >::operator[]

(

size_t

ielement

)

Definition at line 379 of file atlcoll.h.

{
    ATLASSERT(iElement < m_Size);
 
    return m_pData[iElement];
}

operator[]() [2/2]

template<typename E , class ETraits >

const E & ATL::CAtlArray< E, ETraits >::operator[]

(

size_t

ielement

)

const

Definition at line 387 of file atlcoll.h.

{
    ATLASSERT(iElement < m_Size);
 
    return m_pData[iElement];
}

SetCount()

template<typename E , class ETraits >

bool ATL::CAtlArray< E, ETraits >::SetCount	(	size_t	nNewSize,
		int	nGrowBy = - 1
	)

Definition at line 325 of file atlcoll.h.

{
 
    if (nGrowBy > -1)
    {
        m_GrowBy = (size_t)nGrowBy;
    }
 
    if (nNewSize == m_Size)
    {
        // Do nothing
    }
    else if (nNewSize == 0)
    {
        if (m_pData)
        {
            DestructItems(m_pData, m_Size);
            m_pData = NULL;
        }
        m_Size = m_AllocatedSize = NULL;
    }
    else if (nNewSize < m_AllocatedSize)
    {
        if (nNewSize > m_Size)
        {
            CreateItems(m_pData + m_Size, nNewSize - m_Size);
        }
        else
        {
            DestructItems(m_pData + nNewSize, m_Size - nNewSize);
        }
        m_Size = nNewSize;
    }
    else
    {
        if (!GrowAllocatedData(nNewSize))
        {
            return false;
        }
 
        CreateItems(m_pData + m_Size, nNewSize - m_Size);
        m_Size = nNewSize;
    }
 
    return true;
}

Referenced by START_TEST().

Member Data Documentation

m_AllocatedSize

template<typename E , class ETraits = CElementTraits<E>>

size_t ATL::CAtlArray< E, ETraits >::m_AllocatedSize

private

Definition at line 181 of file atlcoll.h.

Referenced by ATL::CAtlArray< E, ETraits >::GrowAllocatedData().

m_GrowBy

template<typename E , class ETraits = CElementTraits<E>>

size_t ATL::CAtlArray< E, ETraits >::m_GrowBy

private

Definition at line 182 of file atlcoll.h.

Referenced by ATL::CAtlArray< E, ETraits >::GrowAllocatedData().

m_pData

template<typename E , class ETraits = CElementTraits<E>>

E* ATL::CAtlArray< E, ETraits >::m_pData

private

Definition at line 179 of file atlcoll.h.

Referenced by ATL::CAtlArray< E, ETraits >::GrowAllocatedData().

m_Size

template<typename E , class ETraits = CElementTraits<E>>

size_t ATL::CAtlArray< E, ETraits >::m_Size

private

Definition at line 180 of file atlcoll.h.

Referenced by ATL::CAtlArray< E, ETraits >::GrowAllocatedData().

---

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

• sdk/lib/atl/atlcoll.h