TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager Interface Reference

Inheritance diagram for TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager:

Public Member Functions
IDictionary< String, TileCacheStats >	GetTileCacheStats ()
	Returns a dictionary keyed on map signature containing statistics for the tile cache.
IDictionary< String, DataReaderStats >	GetDataReaderStats ()
	Returns a dictionary keyed on map signature containing statistics for the data reader.
void	Cleanup ()
	Run cache cleanup. This method will clean up old and unused tiles from all the tile caches. This is normally done automatically from the map layer and elevation data managers, but if you are running the tile cache manager standalone, this method should be called whenever CurrentCacheSize exceeds MaxCacheSize.
void	AddMapDataProvider (string providerId, IMapDataProvider mapDataProvider)
	Register a map data provider with a unique ID.
void	RemoveMapDataProvider (string providerId)
	Remove the registered map data provider with the given ID.
bool	HasMapDataProvider (string providerId)
	Check if a given provider exists in the manager.
void	AddMapDataProvider (MapContentType contentType, IMapDataProvider mMapDataProvider)
	Register a map data provider for the given map content type. You need to register map data providers for all map content types you intend to use. Note that the native MapInterfacer will add a provider for elevation normals automatically when you create an elevation data layer.
void	RemoveMapDataProvider (MapContentType contentType)
	Remove the registered map data provider for the given content type.
INativeTileCache	GetTileCache (IMapContentQuery key)
	Get the tile cache for the given map content query. This method requires that the wanted tile cahce has been created, typically through a map/elevation template.
INativeTileCache	CreateMapTileCache (IMapContentQuery query, IMapDataProvider provider=null)
	Create tile cache for map tiles with optional data provider. If no data provider is given, the default for the requested map content type is used.
void	RemoveTileCache (IMapContentQuery key)
	Erase the given tile cache from the manager.
void	ClearTileCaches ()
	Clear all tile caches. This method will clear all tile data from all tile caches. Please note that tile data can be kept alive by other components of the system, such as the rendering layers and tile data readers, this method will simply remove the references from the tile caches.

Properties
int	MaxCacheSize [get, set]
	Maximum tile cache size in Mb.
int	CurrentCacheSize [get]
	Current tile cache size in Mb.
int	MaxConcurrentRequests [get, set]
	Maximum number of concurrent tile requests. Reduce on systems with fewer cores.

Member Function Documentation

AddMapDataProvider() [1/2]

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.AddMapDataProvider	(	MapContentType	contentType,
		IMapDataProvider	mMapDataProvider
	)

Register a map data provider for the given map content type. You need to register map data providers for all map content types you intend to use. Note that the native MapInterfacer will add a provider for elevation normals automatically when you create an elevation data layer.

Parameters

contentType
mMapDataProvider

AddMapDataProvider() [2/2]

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.AddMapDataProvider	(	string	providerId,
		IMapDataProvider	mapDataProvider
	)

Register a map data provider with a unique ID.

Parameters

providerId	ID for this data provider
mapDataProvider

Cleanup()

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.Cleanup

(

)

Run cache cleanup. This method will clean up old and unused tiles from all the tile caches. This is normally done automatically from the map layer and elevation data managers, but if you are running the tile cache manager standalone, this method should be called whenever CurrentCacheSize exceeds MaxCacheSize.

Implemented in NativeMapLayerBridge::NativeTileCacheManager.

ClearTileCaches()

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.ClearTileCaches

(

)

Clear all tile caches. This method will clear all tile data from all tile caches. Please note that tile data can be kept alive by other components of the system, such as the rendering layers and tile data readers, this method will simply remove the references from the tile caches.

Implemented in NativeMapLayerBridge::NativeTileCacheManager.

CreateMapTileCache()

INativeTileCache TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.CreateMapTileCache	(	IMapContentQuery	query,
		IMapDataProvider	provider = null
	)

Create tile cache for map tiles with optional data provider. If no data provider is given, the default for the requested map content type is used.

Parameters

query	Map content query used as key in the tile cache.
provider	Optional data provider.

Returns

GetDataReaderStats()

IDictionary< String, DataReaderStats > TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.GetDataReaderStats

(

)

Returns a dictionary keyed on map signature containing statistics for the data reader.

Returns

Implemented in NativeMapLayerBridge::NativeTileCacheManager.

GetTileCache()

INativeTileCache TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.GetTileCache

(

IMapContentQuery

key

)

Get the tile cache for the given map content query. This method requires that the wanted tile cahce has been created, typically through a map/elevation template.

Parameters

key	A map content query for the wanted tile cache

Returns

A tile cache interface object, or null if no such tile cache exists.

GetTileCacheStats()

IDictionary< String, TileCacheStats > TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.GetTileCacheStats

(

)

Returns a dictionary keyed on map signature containing statistics for the tile cache.

Returns

Implemented in NativeMapLayerBridge::NativeTileCacheManager.

HasMapDataProvider()

bool TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.HasMapDataProvider

(

string

providerId

)

Check if a given provider exists in the manager.

Parameters

providerId

Returns

RemoveMapDataProvider() [1/2]

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.RemoveMapDataProvider

(

MapContentType

contentType

)

Remove the registered map data provider for the given content type.

Parameters

contentType

Implemented in NativeMapLayerBridge::NativeTileCacheManager.

RemoveMapDataProvider() [2/2]

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.RemoveMapDataProvider

(

string

providerId

)

Remove the registered map data provider with the given ID.

Parameters

providerId

RemoveTileCache()

void TPG.GeoFramework.NativeLayerBridge.Contracts.INativeTileCacheManager.RemoveTileCache

(

IMapContentQuery

key

)

Erase the given tile cache from the manager.

Parameters

key

---

The documentation for this interface was generated from the following file:

• Src/Common/TPG.GeoFramework.NativeLayerBridge.Contracts/INativeTileCacheManager.cs