ossimFixedTileCache Class Reference

#include <ossimFixedTileCache.h>

Inheritance diagram for ossimFixedTileCache:

Public Member Functions
	ossimFixedTileCache ()
virtual void	setRect (const ossimIrect &rect)
virtual void	setRect (const ossimIrect &rect, const ossimIpt &tileSize)
void	keepTilesWithinRect (const ossimIrect &rect)
virtual ossimRefPtr< ossimImageData >	addTile (ossimRefPtr< ossimImageData > imageData, bool duplicateData=true)
virtual ossimRefPtr< ossimImageData >	getTile (ossim_int32 id)
virtual ossimRefPtr< ossimImageData >	getTile (const ossimIpt &origin)
virtual void	setUseLruFlag (bool flag)
virtual bool	getUseLruFlag () const
virtual void	flush ()
virtual void	deleteTile (const ossimIpt &origin)
virtual void	deleteTile (ossim_int32 tileId)
virtual ossimRefPtr< ossimImageData >	removeTile (const ossimIpt &origin)
virtual ossimRefPtr< ossimImageData >	removeTile (ossim_int32 tileId)
virtual const ossimIrect &	getTileBoundaryRect () const
virtual ossim_uint32	getNumberOfTiles () const
virtual const ossimIpt &	getTileSize () const
virtual ossim_uint32	getCacheSize () const
virtual void	deleteTile ()
virtual ossimRefPtr< ossimImageData >	removeTile ()
virtual void	setMaxCacheSize (ossim_uint32 cacheSize)
ossim_uint32	getMaxCacheSize () const
virtual ossimIpt	getTileOrigin (ossim_int32 tileId)
virtual ossim_int32	computeId (const ossimIpt &tileOrigin) const
virtual void	setTileSize (const ossimIpt &tileSize)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Member Functions
virtual	~ossimFixedTileCache ()
virtual void	eraseFromLru (ossim_int32 id)
void	adjustLru (ossim_int32 id)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
std::mutex	theMutex
ossimIrect	theTileBoundaryRect
ossimIpt	theTileSize
ossimIpt	theBoundaryWidthHeight
ossim_uint32	theTilesHorizontal
ossim_uint32	theTilesVertical
ossim_uint32	theCacheSize
ossim_uint32	theMaxCacheSize
std::map< ossim_int32, ossimFixedTileCacheInfo >	theTileMap
std::list< ossim_int32 >	theLruQueue
bool	theUseLruFlag

Detailed Description

Definition at line 63 of file ossimFixedTileCache.h.

Constructor & Destructor Documentation

ossimFixedTileCache()

ossimFixedTileCache::ossimFixedTileCache

(

)

Definition at line 14 of file ossimFixedTileCache.cpp.

References ossim::defaultTileSize(), ossimIrect::makeNan(), setRect(), and theTileSize.

   : theTileBoundaryRect(),
     theTileSize(),
     theBoundaryWidthHeight(),
     theTilesHorizontal(0),
     theTilesVertical(0),
     theCacheSize(0),
     theMaxCacheSize(0),
     theTileMap(),
     theLruQueue(),
     theUseLruFlag(true)
{
   ossim::defaultTileSize(theTileSize);

   ossimIrect tempRect;
   tempRect.makeNan();

   setRect(tempRect);
   
   // theCacheSize    = 0;
   // theMaxCacheSize = 0;
   // theUseLruFlag = true;
}

~ossimFixedTileCache()

ossimFixedTileCache::~ossimFixedTileCache ( )

protectedvirtual

Definition at line 38 of file ossimFixedTileCache.cpp.

References flush().

{
   flush();
}

Member Function Documentation

addTile()

ossimRefPtr< ossimImageData > ossimFixedTileCache::addTile ( ossimRefPtr< ossimImageData >  imageData, bool  duplicateData = true  )

virtual

Definition at line 94 of file ossimFixedTileCache.cpp.

References computeId(), ossimImageData::dup(), ossimImageData::getBuf(), ossimImageData::getDataSizeInBytes(), ossimImageData::getOrigin(), theCacheSize, theLruQueue, theMutex, theTileMap, theUseLruFlag, and ossimRefPtr< T >::valid().

Referenced by ossimAppFixedTileCache::addTile().

{
   std::lock_guard<std::mutex> lock(theMutex);
   ossimRefPtr<ossimImageData> result = NULL;
   if(!imageData.valid())
   {
      return result;
   }
   if(!imageData->getBuf())
   {
      return result;
   }
   
   ossim_int32 id = computeId(imageData->getOrigin());
   if(id < 0)
   {
      return result;
   }
   
   std::map<ossim_int32, ossimFixedTileCacheInfo>::iterator tileIter =
      theTileMap.find(id);

   if(tileIter==theTileMap.end())
   {
      if(duplicateData)
      {
         result = (ossimImageData*)imageData->dup();
      }
      else
      {
         result = imageData;
      }
      ossimFixedTileCacheInfo cacheInfo(result, id);
       
      theCacheSize += imageData->getDataSizeInBytes();
      theTileMap.insert(make_pair(id, cacheInfo));
      if(theUseLruFlag)
      {
         theLruQueue.push_back(id);
      }
   }
   
   return result;
}

adjustLru()

void ossimFixedTileCache::adjustLru ( ossim_int32  id )

protected

Definition at line 280 of file ossimFixedTileCache.cpp.

References theLruQueue, and theUseLruFlag.

Referenced by getTile().

{
   if(theUseLruFlag)
   {
      std::list<ossim_int32>::iterator iter = std::find(theLruQueue.begin(), theLruQueue.end(), id);
      
      if(iter != theLruQueue.end())
      {
         ossim_int32 value = *iter;
         theLruQueue.erase(iter);
         theLruQueue.push_back(value);
      }
   }
}

computeId()

ossim_int32 ossimFixedTileCache::computeId ( const ossimIpt &  tileOrigin ) const

virtual

Definition at line 176 of file ossimFixedTileCache.cpp.

References theBoundaryWidthHeight, theTileBoundaryRect, theTilesHorizontal, theTileSize, ossimIrect::ul(), ossimIpt::x, x, ossimIpt::y, and y.

Referenced by addTile(), deleteTile(), getTile(), keepTilesWithinRect(), and removeTile().

{
   ossimIpt idDiff = tileOrigin - theTileBoundaryRect.ul();

   if((idDiff.x < 0)||
      (idDiff.y < 0)||
      (idDiff.x >= theBoundaryWidthHeight.x)||
      (idDiff.y >= theBoundaryWidthHeight.y))
     {
       return -1;
     }
   ossim_uint32 y = idDiff.y/theTileSize.y;
   y*=theTilesHorizontal;

   ossim_uint32 x = idDiff.x/theTileSize.x;
   
   
   return (y + x);
}

deleteTile() [1/3]

virtual void ossimFixedTileCache::deleteTile ( const ossimIpt &  origin )

inlinevirtual

Definition at line 87 of file ossimFixedTileCache.h.

References computeId(), and deleteTile().

Referenced by ossimAppFixedTileCache::deleteTile(), ossimAppFixedTileCache::shrinkCacheSize(), and ossimAppFixedTileCache::shrinkGlobalCacheSize().

      {
         deleteTile(computeId(origin));
      }

deleteTile() [2/3]

void ossimFixedTileCache::deleteTile ( ossim_int32  tileId )

virtual

Definition at line 196 of file ossimFixedTileCache.cpp.

References eraseFromLru(), theCacheSize, and theTileMap.

{
   std::map<ossim_int32, ossimFixedTileCacheInfo>::iterator tileIter =
      theTileMap.find(tileId);

   if(tileIter != theTileMap.end())
   {
      if((*tileIter).second.theTile.valid())
      {
         theCacheSize -= (*tileIter).second.theTile->getDataSizeInBytes();
         (*tileIter).second.theTile = NULL;
      }
      theTileMap.erase(tileIter);
      eraseFromLru(tileId);
   }
}

deleteTile() [3/3]

void ossimFixedTileCache::deleteTile ( )

virtual

Definition at line 254 of file ossimFixedTileCache.cpp.

References theLruQueue, theMutex, and theUseLruFlag.

Referenced by deleteTile().

{
   std::lock_guard<std::mutex> lock(theMutex);
   if(theUseLruFlag)
   {
      if(theLruQueue.begin() != theLruQueue.end())
      {
         deleteTile(*(theLruQueue.begin()));
      }
   }
}

eraseFromLru()

void ossimFixedTileCache::eraseFromLru ( ossim_int32  id )

protectedvirtual

Definition at line 295 of file ossimFixedTileCache.cpp.

References theLruQueue, and theUseLruFlag.

Referenced by deleteTile(), keepTilesWithinRect(), and removeTile().

{
   if(theUseLruFlag)
   {
      
      std::list<ossim_int32>::iterator iter = std::find(theLruQueue.begin(), theLruQueue.end(), id);
      
      if(iter != theLruQueue.end())
      {
         theLruQueue.erase(iter);
      }
   }
}

flush()

void ossimFixedTileCache::flush ( )

virtual

Definition at line 235 of file ossimFixedTileCache.cpp.

References theCacheSize, theLruQueue, theMutex, and theTileMap.

Referenced by ossimAppFixedTileCache::flush(), setRect(), ossimAppFixedTileCache::shrinkCacheSize(), and ~ossimFixedTileCache().

{
   std::lock_guard<std::mutex> lock(theMutex);
   std::map<ossim_int32, ossimFixedTileCacheInfo>::iterator tileIter =
      theTileMap.begin();

   while(tileIter != theTileMap.end())
   {
      if( (*tileIter).second.theTile.valid())
      {
         (*tileIter).second.theTile = 0;
      }
      ++tileIter;
   }
   theLruQueue.clear();
   theTileMap.clear();
   theCacheSize = 0;
}

getCacheSize()

virtual ossim_uint32 ossimFixedTileCache::getCacheSize ( ) const

inlinevirtual

Definition at line 109 of file ossimFixedTileCache.h.

References theCacheSize.

Referenced by ossimAppFixedTileCache::addTile(), ossimAppFixedTileCache::deleteCache(), ossimAppFixedTileCache::deleteTile(), ossimAppFixedTileCache::flush(), ossimAppFixedTileCache::removeTile(), ossimAppFixedTileCache::setRect(), ossimAppFixedTileCache::setTileSize(), ossimAppFixedTileCache::shrinkCacheSize(), and ossimAppFixedTileCache::shrinkGlobalCacheSize().

      {
         return theCacheSize;
      }

getMaxCacheSize()

ossim_uint32 ossimFixedTileCache::getMaxCacheSize ( ) const

inline

Definition at line 121 of file ossimFixedTileCache.h.

References theMaxCacheSize.

      {
         return theMaxCacheSize;
      }

getNumberOfTiles()

virtual ossim_uint32 ossimFixedTileCache::getNumberOfTiles ( ) const

inlinevirtual

Definition at line 101 of file ossimFixedTileCache.h.

References theTileMap.

      {
         return (ossim_uint32)theTileMap.size();
      }

getTile() [1/2]

ossimRefPtr< ossimImageData > ossimFixedTileCache::getTile ( ossim_int32  id )

virtual

Definition at line 140 of file ossimFixedTileCache.cpp.

References adjustLru(), theMutex, and theTileMap.

Referenced by ossimAppFixedTileCache::getTile(), and getTile().

{
   std::lock_guard<std::mutex> lock(theMutex);
   ossimRefPtr<ossimImageData> result = NULL;

   std::map<ossim_int32, ossimFixedTileCacheInfo>::iterator tileIter =
      theTileMap.find(id);
   if(tileIter!=theTileMap.end())
   {
      result = (*tileIter).second.theTile;
      adjustLru(id);
   }

   return result;
}

getTile() [2/2]

virtual ossimRefPtr<ossimImageData> ossimFixedTileCache::getTile ( const ossimIpt &  origin )

inlinevirtual

Definition at line 74 of file ossimFixedTileCache.h.

References computeId(), and getTile().

      {
         return getTile(computeId(origin));
      }

getTileBoundaryRect()

virtual const ossimIrect& ossimFixedTileCache::getTileBoundaryRect ( ) const

inlinevirtual

Definition at line 97 of file ossimFixedTileCache.h.

References theTileBoundaryRect.

Referenced by ossimAppFixedTileCache::setTileSize().

      {
         return theTileBoundaryRect;
      }

getTileOrigin()

ossimIpt ossimFixedTileCache::getTileOrigin ( ossim_int32  tileId )

virtual

Definition at line 156 of file ossimFixedTileCache.cpp.

References ossimIpt::makeNan(), theMutex, theTileBoundaryRect, theTilesHorizontal, theTileSize, theTilesVertical, ossimIrect::ul(), ossimIpt::x, and ossimIpt::y.

{
   std::lock_guard<std::mutex> lock(theMutex);
   ossimIpt result;
   result.makeNan();

   if(tileId < 0)
   {
      return result;
   }
   ossim_int32 ty = (tileId/theTilesHorizontal);
   ossim_int32 tx = (tileId%theTilesVertical);
   
   ossimIpt ul = theTileBoundaryRect.ul();
   
   result = ossimIpt(ul.x + tx*theTileSize.x, ul.y + ty*theTileSize.y);

   return result;
}

getTileSize()

virtual const ossimIpt& ossimFixedTileCache::getTileSize ( ) const

inlinevirtual

Definition at line 105 of file ossimFixedTileCache.h.

References theTileSize.

Referenced by ossimAppFixedTileCache::getTileSize(), ossimAppFixedTileCache::newTileCache(), ossimAppFixedTileCache::setRect(), and ossimAppFixedTileCache::setTileSize().

      {
         return theTileSize;
      }

getUseLruFlag()

virtual bool ossimFixedTileCache::getUseLruFlag ( ) const

inlinevirtual

Definition at line 82 of file ossimFixedTileCache.h.

References theUseLruFlag.

      {
         return theUseLruFlag;
      }

keepTilesWithinRect()

void ossimFixedTileCache::keepTilesWithinRect

(

const ossimIrect &

rect

)

Definition at line 75 of file ossimFixedTileCache.cpp.

References computeId(), eraseFromLru(), ossimIrect::intersects(), theCacheSize, theMutex, and theTileMap.

{
   std::lock_guard<std::mutex> lock(theMutex);
   std::map<ossim_int32, ossimFixedTileCacheInfo>::iterator tileIter = theTileMap.begin();

   while(tileIter != theTileMap.end())
   {
      ossimIrect tileRect = (*tileIter).second.theTile->getImageRectangle();
      if(!tileRect.intersects(rect))
      {
         eraseFromLru(computeId((*tileIter).second.theTile->getOrigin()));
         theCacheSize -= (*tileIter).second.theTile->getDataSizeInBytes();
         (*tileIter).second.theTile = NULL;
         theTileMap.erase(tileIter);
      }
      ++tileIter;
   }
}

removeTile() [1/3]

virtual ossimRefPtr<ossimImageData> ossimFixedTileCache::removeTile ( const ossimIpt &  origin )

inlinevirtual

Definition at line 92 of file ossimFixedTileCache.h.

References computeId(), and removeTile().

Referenced by ossimAppFixedTileCache::removeTile().

      {
         return removeTile(computeId(origin));
      }

removeTile() [2/3]

ossimRefPtr< ossimImageData > ossimFixedTileCache::removeTile ( ossim_int32  tileId )

virtual

Definition at line 213 of file ossimFixedTileCache.cpp.

References eraseFromLru(), theCacheSize, theMutex, and theTileMap.

{
   std::lock_guard<std::mutex> lock(theMutex);
   ossimRefPtr<ossimImageData> result = NULL;
   
   std::map<ossim_int32, ossimFixedTileCacheInfo>::iterator tileIter =
      theTileMap.find(tileId);

   if(tileIter != theTileMap.end())
   {
      theCacheSize -= (*tileIter).second.theTile->getDataSizeInBytes();
      if((*tileIter).second.theTile.valid())
      {
         result =  (*tileIter).second.theTile;
      }
      theTileMap.erase(tileIter);
      eraseFromLru(tileId);
   }
   
   return result;
}

removeTile() [3/3]

ossimRefPtr< ossimImageData > ossimFixedTileCache::removeTile ( )

virtual

Definition at line 266 of file ossimFixedTileCache.cpp.

References theLruQueue, theMutex, and theUseLruFlag.

Referenced by removeTile().

{
   std::lock_guard<std::mutex> lock(theMutex);
   if(theUseLruFlag)
   {
      if(theLruQueue.begin() != theLruQueue.end())
      {
         return removeTile(*(theLruQueue.begin()));
      }
   }

   return NULL;
}

setMaxCacheSize()

virtual void ossimFixedTileCache::setMaxCacheSize ( ossim_uint32  cacheSize )

inlinevirtual

Definition at line 116 of file ossimFixedTileCache.h.

References theMaxCacheSize.

      {
         theMaxCacheSize = cacheSize;
      }

setRect() [1/2]

void ossimFixedTileCache::setRect ( const ossimIrect &  rect )

virtual

Definition at line 43 of file ossimFixedTileCache.cpp.

References ossim::defaultTileSize(), flush(), ossimIrect::height(), ossimIrect::stretchToTileBoundary(), theBoundaryWidthHeight, theMutex, theTileBoundaryRect, theTilesHorizontal, theTileSize, theTilesVertical, ossimIrect::width(), ossimIpt::x, and ossimIpt::y.

Referenced by ossimAppFixedTileCache::newTileCache(), ossimFixedTileCache(), ossimAppFixedTileCache::setRect(), ossimAppFixedTileCache::setTileSize(), and setTileSize().

{
   {
      std::lock_guard<std::mutex> lock(theMutex);
      ossim::defaultTileSize(theTileSize);
      theTileBoundaryRect      = rect;
      theTileBoundaryRect.stretchToTileBoundary(theTileSize);
      theBoundaryWidthHeight.x = theTileBoundaryRect.width();
      theBoundaryWidthHeight.y = theTileBoundaryRect.height();
      theTilesHorizontal       = theBoundaryWidthHeight.x/theTileSize.x;
      theTilesVertical         = theBoundaryWidthHeight.y/theTileSize.y;
   }
   flush();
}

setRect() [2/2]

void ossimFixedTileCache::setRect ( const ossimIrect &  rect, const ossimIpt &  tileSize  )

virtual

Definition at line 58 of file ossimFixedTileCache.cpp.

References flush(), ossimIrect::height(), ossimIrect::stretchToTileBoundary(), theBoundaryWidthHeight, theMutex, theTileBoundaryRect, theTilesHorizontal, theTileSize, theTilesVertical, ossimIrect::width(), ossimIpt::x, and ossimIpt::y.

{
   {
      std::lock_guard<std::mutex> lock(theMutex);
      theTileBoundaryRect      = rect;
      theTileSize              = tileSize;
      theTileBoundaryRect.stretchToTileBoundary(theTileSize);
      theBoundaryWidthHeight.x = theTileBoundaryRect.width();
      theBoundaryWidthHeight.y = theTileBoundaryRect.height();
      theTilesHorizontal       = theBoundaryWidthHeight.x/theTileSize.x;
      theTilesVertical         = theBoundaryWidthHeight.y/theTileSize.y;
   }
   flush();
}

setTileSize()

void ossimFixedTileCache::setTileSize ( const ossimIpt &  tileSize )

virtual

Definition at line 310 of file ossimFixedTileCache.cpp.

References setRect(), and theTileBoundaryRect.

{
   setRect(theTileBoundaryRect, tileSize);
}

setUseLruFlag()

virtual void ossimFixedTileCache::setUseLruFlag ( bool  flag )

inlinevirtual

Definition at line 78 of file ossimFixedTileCache.h.

References theUseLruFlag.

      {
         theUseLruFlag = flag;
      }

Member Data Documentation

theBoundaryWidthHeight

ossimIpt ossimFixedTileCache::theBoundaryWidthHeight

protected

Definition at line 134 of file ossimFixedTileCache.h.

Referenced by computeId(), and setRect().

theCacheSize

ossim_uint32 ossimFixedTileCache::theCacheSize

protected

Definition at line 137 of file ossimFixedTileCache.h.

Referenced by addTile(), deleteTile(), flush(), getCacheSize(), keepTilesWithinRect(), and removeTile().

theLruQueue

std::list<ossim_int32> ossimFixedTileCache::theLruQueue

protected

Definition at line 140 of file ossimFixedTileCache.h.

Referenced by addTile(), adjustLru(), deleteTile(), eraseFromLru(), flush(), and removeTile().

theMaxCacheSize

ossim_uint32 ossimFixedTileCache::theMaxCacheSize

protected

Definition at line 138 of file ossimFixedTileCache.h.

Referenced by getMaxCacheSize(), and setMaxCacheSize().

theMutex

std::mutex ossimFixedTileCache::theMutex

protected

Definition at line 131 of file ossimFixedTileCache.h.

Referenced by addTile(), deleteTile(), flush(), getTile(), getTileOrigin(), keepTilesWithinRect(), removeTile(), and setRect().

theTileBoundaryRect

ossimIrect ossimFixedTileCache::theTileBoundaryRect

protected

Definition at line 132 of file ossimFixedTileCache.h.

Referenced by computeId(), getTileBoundaryRect(), getTileOrigin(), setRect(), and setTileSize().

theTileMap

std::map<ossim_int32, ossimFixedTileCacheInfo> ossimFixedTileCache::theTileMap

protected

Definition at line 139 of file ossimFixedTileCache.h.

Referenced by addTile(), deleteTile(), flush(), getNumberOfTiles(), getTile(), keepTilesWithinRect(), and removeTile().

theTilesHorizontal

ossim_uint32 ossimFixedTileCache::theTilesHorizontal

protected

Definition at line 135 of file ossimFixedTileCache.h.

Referenced by computeId(), getTileOrigin(), and setRect().

theTileSize

ossimIpt ossimFixedTileCache::theTileSize

protected

Definition at line 133 of file ossimFixedTileCache.h.

Referenced by computeId(), getTileOrigin(), getTileSize(), ossimFixedTileCache(), and setRect().

theTilesVertical

ossim_uint32 ossimFixedTileCache::theTilesVertical

protected

Definition at line 136 of file ossimFixedTileCache.h.

Referenced by getTileOrigin(), and setRect().

theUseLruFlag

bool ossimFixedTileCache::theUseLruFlag

protected

Definition at line 141 of file ossimFixedTileCache.h.

Referenced by addTile(), adjustLru(), deleteTile(), eraseFromLru(), getUseLruFlag(), removeTile(), and setUseLruFlag().

---

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

• ossimFixedTileCache.h
• ossimFixedTileCache.cpp