Cpl::Memory::HPool< T > Class Template Reference

This template class defines a concrete Allocator that allocates its block memory from the HEAP. More...

Detailed Description

template<class T>
class Cpl::Memory::HPool< T >

This template class defines a concrete Allocator that allocates its block memory from the HEAP.

However, once the initial set of blocks are allocated, no more heap operations are performed. All of the memory is aligned to size_t boundaries.

NOTES:

1) If you only need memory for ONE instance - use AlignedClass structure
   in Aligned.h instead.

2) The class is not inherently multi-thread safe.

3) If the requested number of bytes on the allocate() method is greater
   than the block size (i.e. sizeof(T)), 0 is returned.

4) The class can be deleted. However, it is the responsibility of the
   Application to properly clean-up/release ALL outstanding block
   allocations before deleting the HPool instance.

Template args: class "T" is the type of class to allocated

#include <HPool.h>

Inheritance diagram for Cpl::Memory::HPool< T >:

Collaboration diagram for Cpl::Memory::HPool< T >:

Public Member Functions
	HPool (size_t maxNumBlocks, bool fatalErrors=false)
	Constructor.
	~HPool ()
	Destructor.
void *	allocate (size_t numbytes)
	See Cpl::Memory::Allocator.
void	release (void *ptr)
	See Cpl::Memory::Allocator.
size_t	wordSize () const noexcept
	See Cpl::Memory::Allocator.
Public Member Functions inherited from Cpl::Memory::Allocator
size_t	allocatedSizeForNBytes (size_t nbytes) const noexcept
	Convenience method that determines the actual amount of memory that actually allocated for a successful allocate request of N bytes.
virtual	~Allocator ()
	Provide a virtual destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Attributes
Pool_::BlockInfo_ *	m_infoBlocks
	Allocate memory for BlockInfo_ instances.
AlignedClass< T > *	m_blocks
	Allocate blocks.
Pool_ *	m_poolPtr
	My Pool work object.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

HPool()

template<class T >

Cpl::Memory::HPool< T >::HPool ( size_t  maxNumBlocks, bool  fatalErrors = false  )

inline

Constructor.

When the 'fatalErrors' argument is set to true, memory errors (e.g. out-of-memory) will generate a Cpl::System::FatalError call.

~HPool()

template<class T >

Cpl::Memory::HPool< T >::~HPool ( )

inline

Destructor.

Member Function Documentation

allocate()

template<class T >

void * Cpl::Memory::HPool< T >::allocate ( size_t  numbytes )

inlinevirtual

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

release()

template<class T >

void Cpl::Memory::HPool< T >::release ( void *  ptr )

inlinevirtual

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

wordSize()

template<class T >

size_t Cpl::Memory::HPool< T >::wordSize ( ) const

inlinevirtualnoexcept

See Cpl::Memory::Allocator.

Implements Cpl::Memory::Allocator.

Member Data Documentation

m_blocks

template<class T >

AlignedClass<T>* Cpl::Memory::HPool< T >::m_blocks

protected

Allocate blocks.

m_infoBlocks

template<class T >

Pool_::BlockInfo_* Cpl::Memory::HPool< T >::m_infoBlocks

protected

Allocate memory for BlockInfo_ instances.

m_poolPtr

template<class T >

Pool_* Cpl::Memory::HPool< T >::m_poolPtr

protected

My Pool work object.

---

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

• Cpl/Memory/HPool.h