OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::Pool< T > Class Template Reference

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

#include <OgreResourceManager.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
 
 OGRE_AUTO_MUTEX
 

Detailed Description

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

Template class describing a simple pool of items.

Definition at line 45 of file OgreResourceManager.h.

Member Typedef Documentation

template<typename T>
typedef list<T>::type Ogre::Pool< T >::ItemList
protected

Definition at line 48 of file OgreResourceManager.h.

Constructor & Destructor Documentation

template<typename T>
Ogre::Pool< T >::Pool ( )
inline

Definition at line 52 of file OgreResourceManager.h.

template<typename T>
virtual Ogre::Pool< T >::~Pool ( )
inlinevirtual

Definition at line 53 of file OgreResourceManager.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 77 of file OgreResourceManager.h.

template<typename T>
virtual void Ogre::Pool< T >::clear ( void  )
inlinevirtual

Clear the pool.

Reimplemented in Ogre::ResourceManager::ResourcePool.

Definition at line 83 of file OgreResourceManager.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 58 of file OgreResourceManager.h.

Member Data Documentation

template<typename T>
ItemList Ogre::Pool< T >::mItems
protected
template<typename T>
Ogre::Pool< T >::OGRE_AUTO_MUTEX
protected

Definition at line 50 of file OgreResourceManager.h.


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