ossimPool< T > Class Template Reference

Container pool to be used for things like threads. More...

#include <ossimPool.h>

Public Member Functions
	ossimPool (ossim_uint32 n=OSSIM_DEFAULT_POOL_SIZE) throw (std::bad_alloc)
	Contructor. More...
	~ossimPool ()
	Destructor. More...
T *	checkout ()
void	checkin (T *obj) throw (std::out_of_range)
	Resets and eturns object to the pool. More...
std::ostream &	print (std::ostream &out) const
	Outputs object addresses and theAvailableFlag. More...

Protected Attributes
std::vector< ossimPoolObject< T > * >	thePool

Friends
template<class C >
std::ostream &	operator<< (std::ostream &out, const ossimPool< C > &obj)

Detailed Description

template<class T>
class ossimPool< T >

Container pool to be used for things like threads.

Definition at line 26 of file ossimPool.h.

Constructor & Destructor Documentation

ossimPool()

template<class T>

ossimPool< T >::ossimPool ( ossim_uint32  n = OSSIM_DEFAULT_POOL_SIZE ) throw ( std::bad_alloc )

inline

Contructor.

Parameters

n	Number of pooled objects to create.

Definition at line 33 of file ossimPool.h.

References n, ossimNotify(), ossimNotifyLevel_FATAL, ossimPoolObject< T >::theAvailableFlag, ossimPoolObject< T >::theObjectPtr, and ossimPool< T >::thePool.

      : thePool(n)
   {
      for(ossim_uint32 idx = 0; idx < n; ++idx)
      {
         try
         {
               ossimPoolObject<T>* poolObject = new ossimPoolObject<T>();
               poolObject->theAvailableFlag = true;
               poolObject->theObjectPtr = new T();
               thePool[idx] = poolObject;
         }
         catch(std::bad_alloc)
         {
            ossimNotify(ossimNotifyLevel_FATAL)
               << "FATAL ossimPool::ossimPool(): Bad allocation" << endl;
         }
      }
   }

~ossimPool()

template<class T>

ossimPool< T >::~ossimPool ( )

inline

Destructor.

Definition at line 56 of file ossimPool.h.

References ossimPool< T >::thePool.

   {
      thePool.clear();
   }

Member Function Documentation

checkin()

template<class T>

void ossimPool< T >::checkin ( T *  obj ) throw ( std::out_of_range )

inline

Resets and eturns object to the pool.

Parameters

obj	Object to be returned to the pool.

Note

The object is required to have a "reset()" method.

Returns

Returns void unless object was not from pool then throws a std::out_of_range error.

Definition at line 92 of file ossimPool.h.

References ossimPool< T >::thePool.

   {
      theCriticalSectionMutex.lock();
      for (ossim_uint32 idx = 0; idx < thePool.size(); ++idx)
      {
         if (obj == thePool[idx]->theObjectPtr)
         {
            obj->reset();
            thePool[idx]->theAvailableFlag = true;
            theCriticalSectionMutex.unlock();
            return;
         }
      }
      
      theCriticalSectionMutex.unlock();
      throw std::out_of_range(string("ossimPool<T>::checkin Error Object not managed by this pool!"));
   }

checkout()

template<class T>

T* ossimPool< T >::checkout ( )

inline

Returns

A pooled object of type T*. Will return null if the pool is used up or pool size is zero.

Definition at line 65 of file ossimPool.h.

References ossimPool< T >::thePool.

   {
      T* t = NULL;
      
      theCriticalSectionMutex.lock();
      for (ossim_uint32 idx = 0; idx < thePool.size(); ++idx)
      {
         if (thePool[idx]->theAvailableFlag == true)
         {
            thePool[idx]->theAvailableFlag = false;
            t = thePool[idx]->theObjectPtr;
            break;
         }
      }
      theCriticalSectionMutex.unlock();
      return t;
   }

print()

template<class T>

std::ostream& ossimPool< T >::print ( std::ostream &  out ) const

inline

Outputs object addresses and theAvailableFlag.

Definition at line 113 of file ossimPool.h.

References ossimPool< T >::thePool.

   {
      for (ossim_uint32 idx = 0; idx < thePool.size(); ++idx)
      {
         out << "obj address:  " << (hex) << thePool[idx]->theObjectPtr
             << " is "
             << (thePool[idx]->theAvailableFlag ? "available":"unavailable")
             << endl;
      } 
      return out;
   }

Friends And Related Function Documentation

operator<<

template<class T>

template<class C >

std::ostream& operator<< ( std::ostream &  out, const ossimPool< C > &  obj  )

friend

Definition at line 125 of file ossimPool.h.

   {
      return obj.print(out);
   }

Member Data Documentation

thePool

template<class T>

std::vector<ossimPoolObject<T>*> ossimPool< T >::thePool

protected

Definition at line 133 of file ossimPool.h.

Referenced by ossimPool< T >::checkin(), ossimPool< T >::checkout(), ossimPool< T >::ossimPool(), ossimPool< T >::print(), and ossimPool< T >::~ossimPool().

---

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

• ossimPool.h