mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA > Class Template Reference

---

Detailed Description

template<class DATA_PARAMS, class POOLABLE_DATA>
class mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >

A generic system for versatile memory pooling.

This class implements the singleton pattern so a unique instance exists for each combination of template parameters. All methods are thread-safe.

Basic usage:

• When needed, call request_memory() to check the availability of memory in the pool.
  • At your class destructor, donate the memory to the pool with dump_to_pool().

Notice that memory requests are checked against memory blocks in the pool via a user-defined function:

bool POOLABLE_DATA::isSuitable(const POOLABLE_DATA & req) const { ... }

For an example of how to handle a memory pool, see the class mrpt::slam::CObservation3DRangeScan

Template Parameters:

POOLABLE_DATA	A struct with user-defined objects which actually contain the memory blocks (e.g. one or more std::vector).
DATA_PARAMS	A struct with user information about each memory block (e.g. size of a std::vector)

Definition at line 56 of file CGenericMemoryPool.h.

#include <mrpt/system/CGenericMemoryPool.h>

List of all members.

Public Member Functions
size_t	getMemoryPoolMaxSize () const
void	setMemoryPoolMaxSize (const size_t maxNumEntries)
POOLABLE_DATA *	request_memory (const DATA_PARAMS &params)
	Request a block of data which fulfils the size requirements stated in params.
void	dump_to_pool (const DATA_PARAMS &params, POOLABLE_DATA *block)
	Saves the passed data block (characterized by params) to the pool.
	~CGenericMemoryPool ()
Static Public Member Functions
static CGenericMemoryPool < DATA_PARAMS, POOLABLE_DATA > &	getInstance ()
	Singleton: Return the unique instance of this class for a given template arguments:
Private Types
typedef std::list< std::pair < DATA_PARAMS, POOLABLE_DATA * > >	TList
Private Member Functions
	CGenericMemoryPool ()
Private Attributes
TList	m_pool
mrpt::synch::CCriticalSection	m_pool_cs
size_t	m_maxPoolEntries

---

Member Typedef Documentation

template<class DATA_PARAMS, class POOLABLE_DATA>

typedef std::list<std::pair<DATA_PARAMS,POOLABLE_DATA*> > mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::TList [private]

Definition at line 59 of file CGenericMemoryPool.h.

---

Constructor & Destructor Documentation

template<class DATA_PARAMS, class POOLABLE_DATA>

mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::CGenericMemoryPool

(

)

[inline, private]

Definition at line 64 of file CGenericMemoryPool.h.

template<class DATA_PARAMS, class POOLABLE_DATA>

mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::~CGenericMemoryPool

(

)

[inline]

Definition at line 115 of file CGenericMemoryPool.h.

References mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool, and mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool_cs.

---

Member Function Documentation

template<class DATA_PARAMS, class POOLABLE_DATA>

void mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::dump_to_pool	(	const DATA_PARAMS &	params,
		POOLABLE_DATA *	block
	)		[inline]

Saves the passed data block (characterized by params) to the pool.

If the overall size of the pool is above the limit, the oldest entry is removed.

Note:

It is a responsibility of the user to allocate in dynamic memory the "POOLABLE_DATA" object with "new".

Definition at line 105 of file CGenericMemoryPool.h.

References mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_maxPoolEntries, mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool, and mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool_cs.

template<class DATA_PARAMS, class POOLABLE_DATA>

static CGenericMemoryPool<DATA_PARAMS,POOLABLE_DATA>& mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::getInstance

(

)

[inline, static]

Singleton: Return the unique instance of this class for a given template arguments:

Definition at line 73 of file CGenericMemoryPool.h.

template<class DATA_PARAMS, class POOLABLE_DATA>

size_t mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::getMemoryPoolMaxSize

(

)

const [inline]

Definition at line 69 of file CGenericMemoryPool.h.

References mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_maxPoolEntries.

template<class DATA_PARAMS, class POOLABLE_DATA>

POOLABLE_DATA* mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::request_memory

(

const DATA_PARAMS &

params

)

[inline]

Request a block of data which fulfils the size requirements stated in params.

Notice that the decision on the suitability of each pool'ed block is done by DATA_PARAMS::isSuitable().

Returns:

The block of data, or NULL if none suitable was found in the pool.

Note:

It is a responsibility of the user to free with "delete" the "POOLABLE_DATA" object itself once the memory has been extracted from its elements.

Definition at line 84 of file CGenericMemoryPool.h.

References mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool, and mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool_cs.

template<class DATA_PARAMS, class POOLABLE_DATA>

void mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::setMemoryPoolMaxSize

(

const size_t

maxNumEntries

)

[inline]

Definition at line 70 of file CGenericMemoryPool.h.

References mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_maxPoolEntries.

---

Member Data Documentation

template<class DATA_PARAMS, class POOLABLE_DATA>

size_t mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_maxPoolEntries [private]

Definition at line 62 of file CGenericMemoryPool.h.

Referenced by mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::dump_to_pool(), mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::getMemoryPoolMaxSize(), and mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::setMemoryPoolMaxSize().

template<class DATA_PARAMS, class POOLABLE_DATA>

TList mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool [private]

Definition at line 60 of file CGenericMemoryPool.h.

Referenced by mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::dump_to_pool(), mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::request_memory(), and mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::~CGenericMemoryPool().

template<class DATA_PARAMS, class POOLABLE_DATA>

mrpt::synch::CCriticalSection mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::m_pool_cs [private]

Definition at line 61 of file CGenericMemoryPool.h.

Referenced by mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::dump_to_pool(), mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::request_memory(), and mrpt::system::CGenericMemoryPool< DATA_PARAMS, POOLABLE_DATA >::~CGenericMemoryPool().