Champlain.TileCache¶

Subclasses:: Champlain.FileCache, Champlain.MemoryCache

Methods¶

Inherited:: Champlain.MapSource (20), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`on_tile_filled` (tile)
	`refresh_tile_time` (tile)
	`store_tile` (tile, contents, size)

Virtual Methods¶

Inherited:: Champlain.MapSource (9), GObject.Object (7)

	`do_on_tile_filled` (tile)
	`do_refresh_tile_time` (tile)
	`do_store_tile` (tile, contents, size)

Properties¶

Inherited:: Champlain.MapSource (2)

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Champlain.MapSource`	r

Class Details¶

class Champlain.TileCache(**kwargs)¶

Bases:: Champlain.MapSource
Abstract:: Yes
Structure:: Champlain.TileCacheClass

The Champlain.TileCache structure contains only private data and should be accessed using the provided API

New in version 0.6.

on_tile_filled(tile)¶

Parameters:: tile (Champlain.Tile) – a Champlain.Tile

When a cache fills a tile and the next source in the chain is a tile cache, it should call this function on the next source. This way all the caches preceding a tile source in the chain get informed that the tile was used and can modify their metadata accordingly in the implementation of this function. In addition, the call of this function should be chained so within the implementation of this function it should be called on the next source in the chain when next source is a tile cache.

New in version 0.6.

refresh_tile_time(tile)¶

Parameters:: tile (Champlain.Tile) – a Champlain.Tile

Refreshes the tile access time in the cache.

New in version 0.6.

store_tile(tile, contents, size)¶

Parameters:

tile (Champlain.Tile) – a Champlain.Tile
contents (str) – the tile contents that should be stored
size (int) – size of the contents in bytes

Stores the tile including the metadata into the cache.

New in version 0.6.

do_on_tile_filled(tile) virtual¶

Parameters:: tile (Champlain.Tile) – a Champlain.Tile

When a cache fills a tile and the next source in the chain is a tile cache, it should call this function on the next source. This way all the caches preceding a tile source in the chain get informed that the tile was used and can modify their metadata accordingly in the implementation of this function. In addition, the call of this function should be chained so within the implementation of this function it should be called on the next source in the chain when next source is a tile cache.

New in version 0.6.

do_refresh_tile_time(tile) virtual¶

Parameters:: tile (Champlain.Tile) – a Champlain.Tile

Refreshes the tile access time in the cache.

New in version 0.6.

do_store_tile(tile, contents, size) virtual¶

Parameters:

tile (Champlain.Tile) – a Champlain.Tile
contents (str) – the tile contents that should be stored
size (int) – size of the contents in bytes

Stores the tile including the metadata into the cache.

New in version 0.6.