Ogre::Pool< T > Class Template Reference

Template class describing a simple pool of items. More...

#include <OgreCommon.h>

Collaboration diagram for Ogre::Pool< T >:

Public Member Functions
	Pool ()
virtual	~Pool ()
virtual void	addItem (const T &i)
	Add a new item to the pool. More...
virtual void	clear ()
	Clear the pool. More...
virtual std::pair< bool, T >	removeItem ()
	Get the next item from the pool. More...

Protected Types
typedef list< T >::type	ItemList

Protected Attributes
ItemList	mItems

Detailed Description

template<typename T>
class Ogre::Pool< T >

Template class describing a simple pool of items.

Definition at line 821 of file OgreCommon.h.

Member Typedef Documentation

template<typename T>

typedef list<T>::type Ogre::Pool< T >::ItemList

protected

Definition at line 824 of file OgreCommon.h.

Constructor & Destructor Documentation

template<typename T>

Ogre::Pool< T >::Pool ( )

inline

Definition at line 828 of file OgreCommon.h.

template<typename T>

virtual Ogre::Pool< T >::~Pool ( )

inlinevirtual

Definition at line 829 of file OgreCommon.h.

Member Function Documentation

template<typename T>

virtual void Ogre::Pool< T >::addItem ( const T &  i )

inlinevirtual

Add a new item to the pool.

Definition at line 853 of file OgreCommon.h.

template<typename T>

virtual void Ogre::Pool< T >::clear ( )

inlinevirtual

Clear the pool.

Reimplemented in Ogre::ResourceManager::ResourcePool.

Definition at line 859 of file OgreCommon.h.

template<typename T>

virtual std::pair<bool, T> Ogre::Pool< T >::removeItem ( )

inlinevirtual

Get the next item from the pool.

Returns

pair indicating whether there was a free item, and the item if so

Definition at line 834 of file OgreCommon.h.

Member Data Documentation

template<typename T>

ItemList Ogre::Pool< T >::mItems

protected

Definition at line 825 of file OgreCommon.h.

Referenced by Ogre::Pool< ResourcePtr >::addItem(), Ogre::Pool< ResourcePtr >::clear(), and Ogre::Pool< ResourcePtr >::removeItem().

---

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

• OgreCommon.h