This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.tilecache [2015/09/21 08:19] admin |
thinkgeo.mapsuite.portablecore.tilecache [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.TileCache ====== | ====== ThinkGeo.MapSuite.Core.TileCache ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This is the base class for TileCache system. | This is the base class for TileCache system. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 11: | Line 14: | ||
| ** {{wiki:ProtectedMethod.gif|}} TileCache(String,TileImageFormat,TileMatrix) ** | ** {{wiki:ProtectedMethod.gif|}} TileCache(String,TileImageFormat,TileMatrix) ** | ||
| - | This is the constructor of the class. | + | * //This is the constructor of the class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| * //cacheId// | * //cacheId// | ||
| Line 31: | Line 34: | ||
| ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** | ** {{wiki:PublicMethod.gif|}} SaveTile(Tile) ** | ||
| - | This method will save the target tile passed in. | + | * //This method will save the target tile passed in.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 45: | Line 48: | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape,Boolean) ** | + | ** {{wiki:PublicMethod.gif|}} SaveTiles(GeoImage,RectangleShape) ** |
| - | + | ||
| - | N/A | + | |
| - | == Remarks == | + | |
| - | N/A | + | |
| - | + | ||
| - | == Return Value == | + | |
| - | * Type:Void | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | == Parameters == | + | |
| - | * //bitmap// | + | |
| - | * Type:Bitmap | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //bitmapExtent// | + | |
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //saveContainedCellsOnly// | + | |
| - | * Type:Boolean | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | <div newline></div> | + | |
| - | ** {{wiki:PublicMethod.gif|}} SaveTiles(Bitmap,RectangleShape) ** | + | |
| - | This method will save the bitmap with its extent attached into tiles. | + | * //This method will save the bitmap with its extent attached into tiles.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 81: | Line 60: | ||
| == Parameters == | == Parameters == | ||
| * //bitmap// | * //bitmap// | ||
| - | * Type:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| * Description:The target bitmap to be saved into tiles. | * Description:The target bitmap to be saved into tiles. | ||
| Line 91: | Line 70: | ||
| ** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} DeleteTiles(RectangleShape) ** | ||
| - | This method will delete the tiles within the passed in worldExtent. | + | * //This method will delete the tiles within the passed in worldExtent.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 107: | Line 86: | ||
| ** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** | ** {{wiki:PublicMethod.gif|}} DeleteTile(Tile) ** | ||
| - | This method will delete the target tile passed in. | + | * //This method will delete the target tile passed in.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 123: | Line 102: | ||
| ** {{wiki:PublicMethod.gif|}} ClearCache() ** | ** {{wiki:PublicMethod.gif|}} ClearCache() ** | ||
| - | This method will clear all the tiles in the tileCache. | + | * //This method will clear all the tiles in the tileCache.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 135: | Line 114: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 147: | Line 126: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 163: | Line 142: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 175: | Line 154: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 188: | Line 167: | ||
| ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** | ** {{wiki:ProtectedMethod.gif|}} ClearCacheCore() ** | ||
| - | This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method. | + | * //This abstract method will clear all the tiles in the tileCache, for each sub TileCache class must implement this method.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 200: | Line 179: | ||
| ** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** | ** {{wiki:ProtectedMethod.gif|}} SaveTileCore(Tile) ** | ||
| - | This abstract method will save the target tile passed in, for each sub TileCache class must implement this method. | + | * //This abstract method will save the target tile passed in, for each sub TileCache class must implement this method.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 216: | Line 195: | ||
| ** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** | ** {{wiki:ProtectedMethod.gif|}} DeleteTileCore(Tile) ** | ||
| - | This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method. | + | * //This abstract method will delete the target tile passed in, for each sub TileCache class must implement this method.// |
| == Remarks == | == Remarks == | ||
| - | This method will not take effect when the ReadOnly is set to true. | + | * //This method will not take effect when the ReadOnly is set to true.// |
| == Return Value == | == Return Value == | ||
| Line 232: | Line 211: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 244: | Line 223: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 257: | Line 236: | ||
| ** {{wiki:PublicProperty.gif|}} TileMatrix ** | ** {{wiki:PublicProperty.gif|}} TileMatrix ** | ||
| - | Gets or sets the TileMatrix which is used in caculation for tiles. | + | * //Gets or sets the TileMatrix which is used in caculation for tiles.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | * Type:[[ThinkGeo.MapSuite.Core.TileMatrix|TileMatrix]] | ||
| Line 265: | Line 244: | ||
| ** {{wiki:PublicProperty.gif|}} TileAccessMode ** | ** {{wiki:PublicProperty.gif|}} TileAccessMode ** | ||
| - | Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete | + | * //Gets or sets the Mode for the TileCache access the tiles. The Default value is ReadAddDelete// |
| == Remarks == | == Remarks == | ||
| - | If you want it to take effect, you need set the ReadOnly property false. | + | * //If you want it to take effect, you need set the ReadOnly property false.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | * Type:[[ThinkGeo.MapSuite.Core.TileAccessMode|TileAccessMode]] | ||
| Line 273: | Line 252: | ||
| ** {{wiki:PublicProperty.gif|}} NoDataTileImage ** | ** {{wiki:PublicProperty.gif|}} NoDataTileImage ** | ||
| - | This property returns back a preset image showing the tile data is missing. | + | * //This property returns back a preset image showing the tile data is missing.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** | ** {{wiki:PublicProperty.gif|}} LoadingTileImage ** | ||
| - | This property returns back a preset image showing the Tile is loading. | + | * //This property returns back a preset image showing the Tile is loading.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Bitmap | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| ** {{wiki:PublicProperty.gif|}} ImageFormat ** | ** {{wiki:PublicProperty.gif|}} ImageFormat ** | ||
| - | Gets or sets the tile image format. | + | * //Gets or sets the tile image format.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | * Type:[[ThinkGeo.MapSuite.Core.TileImageFormat|TileImageFormat]] | ||
| Line 297: | Line 276: | ||
| ** {{wiki:PublicProperty.gif|}} JpegQuality ** | ** {{wiki:PublicProperty.gif|}} JpegQuality ** | ||
| - | Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg. | + | * //Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Int16 | * Type:Int16 | ||
| Line 305: | Line 284: | ||
| ** {{wiki:PublicProperty.gif|}} CacheId ** | ** {{wiki:PublicProperty.gif|}} CacheId ** | ||
| - | Gets or sets the id of the TileCache. | + | * //Gets or sets the id of the TileCache.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||