User Tools

Site Tools

Trace:
thinkgeo.mapsuite.core.tilecache

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.core.tilecache [2015/08/20 03:08]
127.0.0.1 external edit 		— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.Core.TileCache ====== 
- 
- 
- 
-<!-- Class --> 
-This is the base class for TileCache system. 
-=== Remarks === 
-TileCahce system is very efficient in improving the performance of application,​ especially when large data or remote server images are included. 
-===== Inheritance Hierarchy ===== 
-*System.Object 
-**[[ThinkGeo.MapSuite.Core.TileCache]] 
-***[[ThinkGeo.MapSuite.Core.BitmapTileCache]] 
-***[[ThinkGeo.MapSuite.Core.EncryptedFileBitmapTileCache]] 
-***[[ThinkGeo.MapSuite.Core.FileBitmapTileCache]] 
-***[[ThinkGeo.MapSuite.Core.FileNativeImageTileCache]] 
-***[[ThinkGeo.MapSuite.Core.InMemoryBitmapTileCache]] 
-***[[ThinkGeo.MapSuite.Core.NativeImageTileCache]] 
-===== Members Summary ===== 
-==== Public Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
-==== Protected Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​TileCache(String,​ TileImageFormat,​ TileMatrix)|TileCache]] ​  | String, [[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]],​ [[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] ​  ​| ​   | This is the constructor of the class. ​  | 
- 
-==== Public Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ClearCache()|ClearCache]] ​  ​| ​   |    | This method will clear all the tiles in the tileCache. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​DeleteTile(Tile)|DeleteTile]] ​  | [[ThinkGeo.MapSuite.Core.Tile|Tile]] ​  ​| ​   | This method will delete the target tile passed in.   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​DeleteTiles(RectangleShape)|DeleteTiles]] ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] ​  ​| ​   | This method will delete the tiles within the passed in worldExtent. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​SaveTile(Tile)|SaveTile]] ​  | [[ThinkGeo.MapSuite.Core.Tile|Tile]] ​  ​| ​   | This method will save the target tile passed in.   | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​SaveTiles(Bitmap,​ RectangleShape,​ Boolean)|SaveTiles]] ​  | Bitmap, [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],​ Boolean ​  ​| ​   |    | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​SaveTiles(Bitmap,​ RectangleShape)|SaveTiles]] ​  | Bitmap, [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] ​  ​| ​   | This method will save the bitmap with its extent attached into tiles. ​  | 
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   | 
- 
-==== Protected Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​ClearCacheCore()|ClearCacheCore]] ​  ​| ​   |    | This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method. ​  | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DeleteTileCore(Tile)|DeleteTileCore]] ​  | [[ThinkGeo.MapSuite.Core.Tile|Tile]] ​  ​| ​   | This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method. ​  | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​SaveTileCore(Tile)|SaveTileCore]] ​  | [[ThinkGeo.MapSuite.Core.Tile|Tile]] ​  ​| ​   | This abstract method will save the target tile passed in, for each sub TileCache class must implement this method. ​  | 
- 
-==== Public Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​CacheId|CacheId]] ​  | String ​  ​| ​   | Gets or sets the id of the TileCache. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​ImageFormat|ImageFormat]] ​  | [[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] ​  ​| ​   | Gets or sets the tile image format. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​JpegQuality|JpegQuality]] ​  | Int16   ​| ​   | Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.   | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​LoadingTileImage|LoadingTileImage]] ​  | Bitmap ​  ​| ​   | This property returns back a preset image showing the Tile is loading. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​NoDataTileImage|NoDataTileImage]] ​  | Bitmap ​  ​| ​   | This property returns back a preset image showing the tile data is missing. ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileAccessMode|TileAccessMode]] ​  | [[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] ​  ​| ​   | Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete ​  | 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​TileMatrix|TileMatrix]] ​  | [[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] ​  ​| ​   | Gets or sets the TileMatrix which is used in caculation for tiles. ​  | 
- 
-==== Protected Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
- 
-==== Public Events ==== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ 
- 
-===== Public Constructors ===== 
-===== Protected Constructors ===== 
-==== TileCache(String,​ TileImageFormat,​ TileMatrix) ==== 
-This is the constructor of the class. 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| cacheId ​  | String<​!-- System.String --> ​  | This is the cache identifier which marks its difference with other TileCache. ​  | 
-| imageFormat ​  | [[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]<​!-- ThinkGeo.MapSuite.Core.TileImageFormat --> ​  | This is the imageFormate showing what kind of image we are trying to save.   | 
-| tileMatrix ​  | [[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]<​!-- ThinkGeo.MapSuite.Core.TileMatrix --> ​  | This is the tile matrix system which is used for caculating tiles. ​  | 
- 
-[[#​Protected Constructors|Go Back]] 
-===== Public Methods ===== 
-==== ClearCache() ==== 
-This method will clear all the tiles in the tileCache. 
-=== Remarks === 
-This method will not take effect when the ReadOnly is set to true. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Methods|Go Back]] 
-==== DeleteTile(Tile) ==== 
-This method will delete the target tile passed in. 
-=== Remarks === 
-This method will not take effect when the ReadOnly is set to true. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| tile   | [[ThinkGeo.MapSuite.Core.Tile|Tile]]<​!-- ThinkGeo.MapSuite.Core.Tile --> ​  | The target tile to be deleted. ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Methods|Go Back]] 
-==== DeleteTiles(RectangleShape) ==== 
-This method will delete the tiles within the passed in worldExtent. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| worldExtent ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  | The target extent to delete all tiles within it.   | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Methods|Go Back]] 
-==== Equals(Object) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Boolean<​!-- System.Boolean --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   | 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetHashCode() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Int32<​!-- System.Int32 --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetType() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Type<!-- System.Type --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== SaveTile(Tile) ==== 
-This method will save the target tile passed in. 
-=== Remarks === 
-This method will not take effect when the ReadOnly is set to true. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| tile   | [[ThinkGeo.MapSuite.Core.Tile|Tile]]<​!-- ThinkGeo.MapSuite.Core.Tile --> ​  | The target tile to be saved. ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Methods|Go Back]] 
-==== SaveTiles(Bitmap,​ RectangleShape,​ Boolean) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| bitmap ​  | Bitmap<​!-- System.Drawing.Bitmap --> ​  ​| ​   | 
-| bitmapExtent ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  ​| ​   | 
-| saveContainedCellsOnly ​  | Boolean<​!-- System.Boolean --> ​  ​| ​   | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Methods|Go Back]] 
-==== SaveTiles(Bitmap,​ RectangleShape) ==== 
-This method will save the bitmap with its extent attached into tiles. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| bitmap ​  | Bitmap<​!-- System.Drawing.Bitmap --> ​  | The target bitmap to be saved into tiles. ​  | 
-| bitmapExtent ​  | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<​!-- ThinkGeo.MapSuite.Core.RectangleShape --> ​  | The target extent for the bitmap. ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Methods|Go Back]] 
-==== ToString() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| String<​!-- System.String --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-===== Protected Methods ===== 
-==== ClearCacheCore() ==== 
-This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method. 
-=== Remarks === 
-This method will not take effect when the ReadOnly is set to true. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#​Protected Methods|Go Back]] 
-==== DeleteTileCore(Tile) ==== 
-This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method. 
-=== Remarks === 
-This method will not take effect when the ReadOnly is set to true. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| tile   | [[ThinkGeo.MapSuite.Core.Tile|Tile]]<​!-- ThinkGeo.MapSuite.Core.Tile --> ​  | The target tile to be deleted. ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#​Protected Methods|Go Back]] 
-==== Finalize() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== MemberwiseClone() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Object<​!-- System.Object --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== SaveTileCore(Tile) ==== 
-This abstract method will save the target tile passed in, for each sub TileCache class must implement this method. 
-=== Remarks === 
-This method will not take effect when the ReadOnly is set to true. 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| tile   | [[ThinkGeo.MapSuite.Core.Tile|Tile]]<​!-- ThinkGeo.MapSuite.Core.Tile --> ​  | The target tile to be saved. ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#​Protected Methods|Go Back]] 
-===== Public Properties ===== 
-==== CacheId ==== 
-Gets or sets the id of the TileCache. 
-=== Return Value === 
-^ Return Type ^ 
-| String<​!-- System.String --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-==== ImageFormat ==== 
-Gets or sets the tile image format. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]]<​!-- ThinkGeo.MapSuite.Core.TileImageFormat --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-==== JpegQuality ==== 
-Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg. 
-=== Return Value === 
-^ Return Type ^ 
-| Int16<​!-- System.Int16 --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-==== LoadingTileImage ==== 
-This property returns back a preset image showing the Tile is loading. 
-=== Return Value === 
-^ Return Type ^ 
-| Bitmap<​!-- System.Drawing.Bitmap --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-==== NoDataTileImage ==== 
-This property returns back a preset image showing the tile data is missing. 
-=== Return Value === 
-^ Return Type ^ 
-| Bitmap<​!-- System.Drawing.Bitmap --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-==== TileAccessMode ==== 
-Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete 
-=== Remarks === 
-If you want it to take effect, you need set the ReadOnly property false. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]]<​!-- ThinkGeo.MapSuite.Core.TileAccessMode --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-==== TileMatrix ==== 
-Gets or sets the TileMatrix which is used in caculation for tiles. 
-=== Return Value === 
-^ Return Type ^ 
-| [[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]]<​!-- ThinkGeo.MapSuite.Core.TileMatrix --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.TileCache --> 
-[[#Public Properties|Go Back]] 
-===== Protected Properties ===== 
-===== Public Events ===== 
-__NOTOC__ 
-[[Category:​MapSuiteCore]] 
-[[Category:​ThinkGeo.MapSuite.Core]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.core.tilecache.1440040130.txt.gz ยท Last modified: 2015/09/17 10:40 (external edit)

Page Tools