mapsglmaps/com.xweather.mapsgl.sources/XweatherEncodedTileSource

XweatherEncodedTileSource

class XweatherEncodedTileSource(var id: String, var authenticator: XweatherAuthenticator?) : EncodedTileSource

XweatherEncodedTileSource.kt

A subclass of EncodedTileSource that is used to request and process encoded tile data from the MapsGL server.

Based on the IOS version.

Author

Jason Suto 01/08/24

Constructors

XweatherEncodedTileSource

constructor(id: String, authenticator: XweatherAuthenticator?)

Types

object Companion

enum Error : Enum<XweatherEncodedTileSource.Error>

Properties

_shouldTriggerLoadCompleteEvent

var _shouldTriggerLoadCompleteEvent: Boolean

val animTileList: MutableList<String>

open override var authenticator: XweatherAuthenticator?

var bounds: LatLonBounds?

open override var datasets: List<DatasetType>

eventDispatcher

open override val eventDispatcher: EventDispatcher

open override var id: String

Same id as the registered style source / descriptor.

open override val isEncoded: Boolean = true

var isLoading: Boolean

open override var isReady: Boolean

true when metadata (and any bootstrap work) is available so layers can request tiles safely.

val TileSource<DataType>.isReady: Boolean

var isStale: Boolean

open override var kind: DataSourceKind

High-level source family (raster, encoded, vector, …).

var maxZoom: Float

val TileSource<DataType>.maxZoom: Float

lateinit var metadata: SourceMetadata<MetadataType>

var metaDataNeeded: Int

metadataObserver

val metadataObserver: VariableObserver

var metadataURL: String?

var minZoom: Float

val TileSource<DataType>.minZoom: Float

val TileSource<DataType>.needsMetadata: Boolean

ownerMapSessionId

var ownerMapSessionId: Long

com.xweather.mapsgl.map.MapController.mapSessionId that owns in-flight / ready tile bookkeeping.

lateinit var passedObserver: Observer<String>

pendingRequestedTiles

var pendingRequestedTiles: MutableList<String>

val requests: <Error class: unknown class>

shouldTriggerLoadCompleteEvent

val shouldTriggerLoadCompleteEvent: Boolean = false

threadSafeIntervalMap

val threadSafeIntervalMap: ConcurrentHashMap<String, List<String>?>

threadSafeTileMap

val threadSafeTileMap: ConcurrentHashMap<String, Tile<DataType>>

open override var tileCache: TileCache<DataType>

open override var tileManager: TileRequestManager<DataType>

val TileSource<DataType>.tiles: TileCache<DataType>

var tileSize: TileSize

val TileSource<DataType>.tileSize: TileSize

var tileURL: String?

open override var timeRange: ClosedRange<Date>?

Optional interval filter for time-series products; drives tile requests with timeline state.

val type: String

val DataSource.type: DataSourceKind

Alias for DataSource.kind (matches JS naming type).

Functions

open override fun addConsumer(consumer: DataSourceConsumer)

Register a layer that should receive updates when this source loads or changes.

addOnEncodedTileReadyListener

fun addOnEncodedTileReadyListener(listener: (TileCoord) -> Unit)

addToAnimationQueue

fun addToAnimationQueue(inputString: String)

adjustDateBySeconds

fun adjustDateBySeconds(dateString: String, offsetSeconds: Long): String?

Used by prepareTileRequest() to increment or decremnet the time and reformate it for sources with time offets

open fun contains(coord: TileCoord): Boolean

fun <DataType : TileData> TileSource<DataType>.contains(coord: TileCoord): Boolean

fun dataRange(channel: SampleChannel): ClosedRange<Double>

Returns the data range for the specified channel.

extractValidTimes

fun extractValidTimes(jsonString: String): List<String>

open suspend override fun fetchMetadata(startDate: Date?, endDate: Date?): Result<Unit>

Returns the metadata for the source, which can be loaded from a remote source.

fun getDataRange(band: ColorBand): ClosedRange<Double>

fun getDataRange(band: Int): ClosedRange<Double>

getImageColorFormat

fun getImageColorFormat(imageBytes: ByteArray): Bitmap.Config?

Test function to detect color format of image

fun getMetadata(band: ColorBand): DatasetType?

fun getMetadata(band: Int): DatasetType?

open override fun getMetadataURL(): URL?

open fun getTileData(coord: TileCoord): Any?

fun <DataType : TileData> TileSource<DataType>.init(id: String, authenticator: Authenticator<MediaSession.Token>?)

intervalToIsoPathTime

fun intervalToIsoPathTime(intervalTime: String): String

Plain ISO-8601 for URL path {time} segments (encoded tile GET). Cache keys and POST validTimes still use bracketed ["…"] strings.

intervalToURLTime

fun intervalToURLTime(intervalTime: String): String

convert from \"2025-04-22T03:49:31Z\" to 20250422030000

fun makeTileURL(coord: TileCoord, variables: Map<String, Any>?): URL

fun metadata(forChannel: SampleChannel): EncodedDataset?

Returns the metadata for the specified channel, if available.

fun onLoadFailed()

fun onTileError(tile: TileType, error: Error)

suspend fun onTileLoaded(tile: TileType, intervals: List<String>?, mode: Int, imageBytes: ByteArray? = null)

Backfills the edges of the tile with its neighbors' data and vice versa. This mirrors the logic found in the JavaScript SDK for seamless tile stitching.

suspend fun parseTile(tile: TileType, data: ByteArray, headers: <Error class: unknown class><Any, Any>?): Bitmap

prepareTileRequest

open fun prepareTileRequest(request: URLRequest, timeString: String?)

fun prepareTileRequest(request: URLRequest, timeString: String?, intervals: List<String>?)

inline fun <EventType : Event> EventSource.publisher(eventType: Class<EventType>): Flow<EventType>

open override fun removeConsumer(layerId: String)

Removes a consumer

removeFromAnimationQueue

fun removeFromAnimationQueue(inputString: String)

open suspend override fun requestTiles(coord: TileCoord, options: TileRequestOptions, currentDate: String, fromAnimation: Boolean, intervals: List<String>?, trackDownloadProgress: Boolean): Any

fun setObserver(observer: Observer<String>, layerID: String)

shouldRequestTile

fun shouldRequestTile(tile: TileType, reload: Boolean): Boolean

shouldRequestTile

fun <DataType : TileData> TileSource<DataType>.shouldRequestTile(tile: TileType, reload: Boolean): Boolean

inline suspend fun <EventType : Event> EventSource.subscribe(eventType: Class<EventType>, crossinline handler: (EventType) -> Unit)

fun <EventType : Event> EventSource.trigger(event: EventType)