Leviathan::BasicPool< ElementType > Class Template Reference

A tiny wrapper around boost pool. More...

#include <ObjectPool.h>

Public Member Functions
	BasicPool ()
	~BasicPool ()
template<typename... Args>
ElementType *	ConstructNew (Args &&... args)
	Constructs a new component of the held type for entity. More...
void	Destroy (ElementType *element)
	Destroys a created element. More...

Protected Attributes
boost::pool	Elements
	Pool for objects. More...

Detailed Description

template<class ElementType>
class Leviathan::BasicPool< ElementType >

A tiny wrapper around boost pool.

Definition at line 24 of file ObjectPool.h.

Constructor & Destructor Documentation

BasicPool()

template<class ElementType>

Leviathan::BasicPool< ElementType >::BasicPool ( )

inline

Definition at line 26 of file ObjectPool.h.

        :
        Elements(sizeof(ElementType), 16)
#endif // LEVIATHAN_USE_ACTUAL_OBJECT_POOLS
    {}

~BasicPool()

template<class ElementType>

Leviathan::BasicPool< ElementType >::~BasicPool ( )

inline

Definition at line 33 of file ObjectPool.h.

{}

Member Function Documentation

ConstructNew()

template<class ElementType>

template<typename... Args>

ElementType* Leviathan::BasicPool< ElementType >::ConstructNew ( Args &&...  args )

inline

Constructs a new component of the held type for entity.

Exceptions

Exception

when component has not been created

Definition at line 40 of file ObjectPool.h.

    {
        // Get memory to hold the object //
        void* memoryForObject = Elements.malloc();

        if(!memoryForObject)
            throw Exception("Out of memory for element");

        // Construct the object //
        ElementType* created;
        try {
            created = new(memoryForObject) ElementType(std::forward<Args>(args)...);
        } catch(...) {

            Elements.free(memoryForObject);
            throw;
        }

        return created;
    }

Destroy()

template<class ElementType>

void Leviathan::BasicPool< ElementType >::Destroy ( ElementType *  element )

inline

Destroys a created element.

Definition at line 62 of file ObjectPool.h.

    {

        element->~ElementType();
        Elements.free(element);
    }

Member Data Documentation

Elements

template<class ElementType>

boost::pool Leviathan::BasicPool< ElementType >::Elements

protected

Pool for objects.

Definition at line 85 of file ObjectPool.h.

---

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

• ObjectPool.h