ossimAppTileCache Class Reference

#include <ossimAppTileCache.h>

Classes
struct	ossimAppCacheTileInfo

Public Types
typedef ossim_int32	ossimAppCacheId
typedef ossim_int32	ossimTileId
typedef map< ossimAppCacheId, ossimTileCache * >::iterator	AppIdIterator

Public Member Functions
	~ossimAppTileCache ()
ossimAppCacheId	newTileCache (ossim_uint32 bucketSize=DEFAULT_BUCKET_SIZE)
ossimDataObject *	get (ossimAppCacheId id, const ossimDpt3d &origin, ossim_uint32 resLevel=0)
ossimRefPtr< ossimDataObject >	removeTile (ossimAppCacheId id, const ossimDpt3d &origin, unsigned long resLevel)
ossimRefPtr< ossimDataObject >	insert (ossimAppCacheId id, const ossimDpt3d &origin, const ossimDataObject *data, ossim_uint32 resLevel=0)
void	deleteCache (ossimAppCacheId appId)

Static Public Member Functions
static ossimAppTileCache *	instance (ossim_uint32 maxSize=0)

Static Public Attributes
static const ossim_uint32	DEFAULT_SIZE = 80*1024*1024
static const ossim_uint32	DEFAULT_BUCKET_SIZE = 293

Protected Member Functions
	ossimAppTileCache (ossim_uint32 maxSize=DEFAULT_SIZE)
void	deleteAll ()
ossimTileCache *	get (ossimAppCacheId id)
void	deleteAppCacheFromQueue (ossimAppCacheId appId)
void	removeTileFromQueue (ossimAppCacheId appId, const ossimDpt3d &origin, ossim_uint32 resLevel)
void	adjustQueue (ossimAppCacheId id, const ossimDpt3d &origin, ossim_uint32 resLevel)
ossimRefPtr< ossimDataObject >	removeTile ()

Protected Attributes
map< ossimAppCacheId, ossimTileCache * >	theAppCache
ossim_uint32	theMaxGlobalCacheSize
ossim_uint32	theMaxCacheSize
ossim_uint32	theCurrentCacheSize
list< ossimAppCacheTileInfo >	theUsedQueue

Static Protected Attributes
static ossimAppTileCache *	theInstance = 0
static ossimAppCacheId	theUniqueAppIdCounter = 1

Detailed Description

Definition at line 27 of file ossimAppTileCache.h.

Member Typedef Documentation

AppIdIterator

typedef map<ossimAppCacheId, ossimTileCache*>::iterator ossimAppTileCache::AppIdIterator

Definition at line 36 of file ossimAppTileCache.h.

ossimAppCacheId

typedef ossim_int32 ossimAppTileCache::ossimAppCacheId

Definition at line 34 of file ossimAppTileCache.h.

ossimTileId

typedef ossim_int32 ossimAppTileCache::ossimTileId

Definition at line 35 of file ossimAppTileCache.h.

Constructor & Destructor Documentation

~ossimAppTileCache()

ossimAppTileCache::~ossimAppTileCache

(

)

Definition at line 52 of file ossimAppTileCache.cpp.

References deleteAll().

{
   deleteAll();
}

ossimAppTileCache()

ossimAppTileCache::ossimAppTileCache ( ossim_uint32  maxSize = DEFAULT_SIZE )

inlineprotected

Definition at line 104 of file ossimAppTileCache.h.

Referenced by instance().

      :
         theMaxCacheSize(maxSize),
         theCurrentCacheSize(0)
      {}

Member Function Documentation

adjustQueue()

void ossimAppTileCache::adjustQueue ( ossimAppCacheId  id, const ossimDpt3d &  origin, ossim_uint32  resLevel  )

protected

Definition at line 284 of file ossimAppTileCache.cpp.

References theUsedQueue.

Referenced by get().

{
   list<ossimAppCacheTileInfo>::iterator anIterator = theUsedQueue.begin();
   ossimAppCacheTileInfo info(id, origin, resLevel);
   
   while(anIterator != theUsedQueue.end())
   {
     
      if((*anIterator) == info)
      {
         theUsedQueue.erase(anIterator);
         theUsedQueue.push_back(info);
         return;
      }
      ++anIterator;
   }              
}

deleteAll()

void ossimAppTileCache::deleteAll ( )

protected

Definition at line 210 of file ossimAppTileCache.cpp.

References theAppCache.

Referenced by ~ossimAppTileCache().

{
   AppIdIterator iter = theAppCache.begin();

   while(iter != theAppCache.end())
   {
      delete (*iter).second;
      ++iter;
   }
   
   theAppCache.clear();
}

deleteAppCacheFromQueue()

void ossimAppTileCache::deleteAppCacheFromQueue ( ossimAppCacheId  appId )

protected

will remove all occurances of the appId from the queue

Definition at line 246 of file ossimAppTileCache.cpp.

References theUsedQueue.

Referenced by deleteCache().

{
   list<ossimAppCacheTileInfo>::iterator anIterator;

   anIterator = theUsedQueue.begin();
   while(anIterator != theUsedQueue.end())
   {
      if( (*anIterator).theAppCacheId == appId)
      {
         anIterator = theUsedQueue.erase(anIterator);
      }
      else
      {
         ++anIterator;
      }
   }
}

deleteCache()

void ossimAppTileCache::deleteCache

(

ossimAppCacheId

appId

)

This will delete the specified cache. The LRU queue will be updated accordingly

Definition at line 192 of file ossimAppTileCache.cpp.

References deleteAppCacheFromQueue(), ossimTileCache::sizeInBytes(), theAppCache, and theCurrentCacheSize.

{
   // first delete the cache
   AppIdIterator anIterator = theAppCache.find(appId);
   if(anIterator != theAppCache.end())
   {
      ossimTileCache *aCache = (*anIterator).second;
      theCurrentCacheSize -= aCache->sizeInBytes();

      delete aCache;

      theAppCache.erase(anIterator);      
   }
   // now delete all occurences of the appCacheId in the queue
   // used for LRU algorithm.
   deleteAppCacheFromQueue(appId);
}

get() [1/2]

ossimDataObject * ossimAppTileCache::get	(	ossimAppCacheId	id,
		const ossimDpt3d &	origin,
		ossim_uint32	resLevel = 0
	)

Will retrieve a tile from the cache. Will return NULL if not found.

Will retrieve a tile from the cache.

Definition at line 77 of file ossimAppTileCache.cpp.

References adjustQueue(), and ossimTileCache::get().

{
   ossimDataObject* result = 0;
   if(id>0)
   {
      ossimTileCache *aCache = this->get(id);
      if(aCache)
      {
         result = aCache->get(origin,
                              resLevel);
         if(result)
         {
            adjustQueue(id, origin, resLevel);
         }
      }
   }

   return result;
}

get() [2/2]

ossimTileCache * ossimAppTileCache::get ( ossimAppCacheId  id )

protected

Used to get access to the App cache.

Definition at line 178 of file ossimAppTileCache.cpp.

References theAppCache.

{
   ossimTileCache *result=0;
   
   AppIdIterator anIterator = theAppCache.find(id);
   
   if(anIterator != theAppCache.end())
   {
      result = (*anIterator).second;
   }

   return result;
}

insert()

ossimRefPtr< ossimDataObject > ossimAppTileCache::insert	(	ossimAppCacheId	id,
		const ossimDpt3d &	origin,
		const ossimDataObject *	data,
		ossim_uint32	resLevel = 0
	)

Will insert a tile into the cache.

Definition at line 124 of file ossimAppTileCache.cpp.

References ossimObject::dup(), ossimRefPtr< T >::get(), ossimDataObject::getDataSizeInBytes(), ossimTileCache::insert(), ossimNotify(), ossimNotifyLevel_WARN, removeTile(), theCurrentCacheSize, theMaxCacheSize, and theUsedQueue.

{
   static const char MODULE[] = "ossimAppTileCache::insert";
   ossimDataObject *result = 0;

   // find the cache and if it's not there then return NULL
   ossimTileCache *aCache = this->get(appId);
   if(!aCache)
   {         
      return result;
   }
   
   ossimRefPtr<ossimDataObject> tileToInsert = 0;
   long dataSize = data->getDataSizeInBytes();
   
   if( (theCurrentCacheSize+dataSize) > theMaxCacheSize)
   {
      do
      {
         ossimRefPtr<ossimDataObject> tile = removeTile();
      }while((theCurrentCacheSize+dataSize) > theMaxCacheSize);
   }

   if(data)
   {
      tileToInsert = (ossimDataObject*)data->dup();

      result = aCache->insert(origin,
                              tileToInsert.get(),
                              resLevel);
      if(!result)
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " ERROR: can't insert and should not happen"
            << endl;

         tileToInsert = 0;
      }
      else
      {
         theCurrentCacheSize += dataSize;
         theUsedQueue.push_back(ossimAppCacheTileInfo(appId,
                                                 origin,
                                                 resLevel));
      }
   }

   return result;
}

instance()

ossimAppTileCache * ossimAppTileCache::instance ( ossim_uint32  maxSize = 0 )

static

We will force a singleton on this class.

Definition at line 28 of file ossimAppTileCache.cpp.

References DEFAULT_SIZE, ossimPreferences::findPreference(), ossimPreferences::instance(), ossimAppTileCache(), ossimNotify(), ossimNotifyLevel_NOTICE, theInstance, and ossimString::toUInt32().

{
   if(!theInstance)
   {
      if(maxSize < 1)
      {
         ossimString cacheSize = ossimPreferences::instance()->findPreference("cache_size");
         if(cacheSize!="")
         {
            maxSize = cacheSize.toUInt32()*1024*1024;
         }
         else
         {
            maxSize = DEFAULT_SIZE;
         }
         ossimNotify(ossimNotifyLevel_NOTICE)
            << "Setting SIZE----------------------- " << maxSize << std::endl;
      }
      theInstance = new ossimAppTileCache(maxSize);
   }

   return theInstance;
}

newTileCache()

ossimAppTileCache::ossimAppCacheId ossimAppTileCache::newTileCache

(

ossim_uint32

bucketSize = DEFAULT_BUCKET_SIZE

)

Will create a new Tile cache for this application. Will return 0 if not successful.

Definition at line 57 of file ossimAppTileCache.cpp.

References theAppCache, and theUniqueAppIdCounter.

{
   ossimTileCache *aCache = 0;
   ossimAppCacheId result = 0;

   aCache = new ossimTileCache(bucketSize);

   if(aCache)
   {
      theAppCache.insert(make_pair(theUniqueAppIdCounter, aCache));
      result = theUniqueAppIdCounter;
      ++theUniqueAppIdCounter;
   }

   return result;
}

removeTile() [1/2]

ossimRefPtr< ossimDataObject > ossimAppTileCache::removeTile	(	ossimAppCacheId	id,
		const ossimDpt3d &	origin,
		unsigned long	resLevel
	)

Will remove a tile completly from the cache. The returned tile is no longer owned by the cache.

Definition at line 99 of file ossimAppTileCache.cpp.

References ossimDataObject::getDataSizeInBytes(), ossimTileCache::remove(), removeTileFromQueue(), theCurrentCacheSize, and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimDataObject> result = 0;
   if(id>0)
   {
      ossimTileCache *aCache = this->get(id);
      if(aCache)
      {
         // remove from cache
         result = aCache->remove(origin,
                                 resLevel);
         // adjust the byte count
         if(result.valid())
         {
            theCurrentCacheSize -= result->getDataSizeInBytes();
         }
         removeTileFromQueue(id, origin, resLevel);
      }
   }

   return result;
}

removeTile() [2/2]

ossimRefPtr< ossimDataObject > ossimAppTileCache::removeTile ( )

protected

will pop the queue and remove that tile from its cache and return it to the caller. This is used by the insert when the max cache size is exceeded.

Definition at line 264 of file ossimAppTileCache.cpp.

References ossimDataObject::getDataSizeInBytes(), ossimTileCache::remove(), ossimAppTileCache::ossimAppCacheTileInfo::theAppCacheId, theCurrentCacheSize, ossimAppTileCache::ossimAppCacheTileInfo::theOrigin, ossimAppTileCache::ossimAppCacheTileInfo::theResLevel, and theUsedQueue.

Referenced by insert().

{
   ossimRefPtr<ossimDataObject> result;
   if(!theUsedQueue.empty())
   {
      ossimAppCacheTileInfo &info = *(theUsedQueue.begin());

      ossimTileCache *aCache = get(info.theAppCacheId);
      if(aCache)
      {
         result            = aCache->remove(info.theOrigin,
                                            info.theResLevel);
         theCurrentCacheSize -= result->getDataSizeInBytes();
      }
      theUsedQueue.erase(theUsedQueue.begin());
   }

   return result;
}

removeTileFromQueue()

void ossimAppTileCache::removeTileFromQueue ( ossimAppCacheId  appId, const ossimDpt3d &  origin, ossim_uint32  resLevel  )

protected

Will remove a single instance of a tile from the queue.

Definition at line 223 of file ossimAppTileCache.cpp.

References theUsedQueue.

Referenced by removeTile().

{
   list<ossimAppCacheTileInfo>::iterator anIterator;

   anIterator = theUsedQueue.begin();
   while(anIterator != theUsedQueue.end())
   {
      if( ((*anIterator).theAppCacheId == appId) &&
          ((*anIterator).theOrigin     == origin)&&
          ((*anIterator).theResLevel   == resLevel))
      {
         theUsedQueue.erase(anIterator);
         return;
      }
      else
      {
         ++anIterator;
      }
   }
}

Member Data Documentation

DEFAULT_BUCKET_SIZE

const ossim_uint32 ossimAppTileCache::DEFAULT_BUCKET_SIZE = 293

static

Definition at line 32 of file ossimAppTileCache.h.

DEFAULT_SIZE

const ossim_uint32 ossimAppTileCache::DEFAULT_SIZE = 80*1024*1024

static

Definition at line 30 of file ossimAppTileCache.h.

Referenced by instance().

theAppCache

map<ossimAppCacheId, ossimTileCache*> ossimAppTileCache::theAppCache

protected

Will hold the list of application caches

Definition at line 148 of file ossimAppTileCache.h.

Referenced by deleteAll(), deleteCache(), get(), and newTileCache().

theCurrentCacheSize

ossim_uint32 ossimAppTileCache::theCurrentCacheSize

protected

This holds the current cache size.

Definition at line 160 of file ossimAppTileCache.h.

Referenced by deleteCache(), insert(), and removeTile().

theInstance

ossimAppTileCache * ossimAppTileCache::theInstance = 0

staticprotected

Definition at line 140 of file ossimAppTileCache.h.

Referenced by instance().

theMaxCacheSize

ossim_uint32 ossimAppTileCache::theMaxCacheSize

protected

Definition at line 154 of file ossimAppTileCache.h.

Referenced by insert().

theMaxGlobalCacheSize

ossim_uint32 ossimAppTileCache::theMaxGlobalCacheSize

protected

Is the maximum size of the cache.

Definition at line 153 of file ossimAppTileCache.h.

theUniqueAppIdCounter

ossimAppTileCache::ossimAppCacheId ossimAppTileCache::theUniqueAppIdCounter = 1

staticprotected

Will hold the current unique Application id.

Definition at line 144 of file ossimAppTileCache.h.

Referenced by newTileCache().

theUsedQueue

list<ossimAppCacheTileInfo> ossimAppTileCache::theUsedQueue

protected

Is used in an Least recently used algorithm

Definition at line 166 of file ossimAppTileCache.h.

Referenced by adjustQueue(), deleteAppCacheFromQueue(), insert(), removeTile(), and removeTileFromQueue().

---

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

• ossimAppTileCache.h
• ossimAppTileCache.cpp