Ogre::Pool< T > Class Template Reference
General

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

`#include <OgreCommon.h>`

List of all members.

## Public Member Functions

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

## 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 819 of file OgreCommon.h.

## Member Typedef Documentation

template<typename T>

typedef list<T>::type Ogre::Pool< T >::ItemList `[protected]`

Definition at line 822 of file OgreCommon.h.

## Constructor & Destructor Documentation

template<typename T>

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

Definition at line 826 of file OgreCommon.h.

template<typename T>

virtual Ogre::Pool< T >::~Pool | ( |  | ) | `[virtual]`

Definition at line 827 of file OgreCommon.h.

## Member Function Documentation

template<typename T>

virtual void Ogre::Pool< T >::addItem | ( | const T & | i | ) | `[virtual]`

Add a new item to the pool.

Definition at line 851 of file OgreCommon.h.

template<typename T>

virtual void Ogre::Pool< T >::clear | ( |  | ) | `[virtual]`

Clear the pool.

Reimplemented in Ogre::ResourceManager::ResourcePool.

Definition at line 857 of file OgreCommon.h.

template<typename T>

virtual std::pair<bool, T> Ogre::Pool< T >::removeItem | ( |  | ) | `[virtual]`

Get the next item from the pool.

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

Definition at line 832 of file OgreCommon.h.

## Member Data Documentation

template<typename T>

ItemList Ogre::Pool< T >::mItems `[protected]`

Definition at line 823 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

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:26