mapsglmaps/com.xweather.mapsgl.map/MapsGLLayerError

MapsGLLayerError

data class MapsGLLayerError(val reason: MapsGLLayerError.Reason, val layerCode: String?, val layerId: String?, val message: String, val cause: Throwable? = null)

A layer that could not be added, or could not draw, reported on MapController.onLayerError (and MapController.onLayerErrorValue for flow collectors).

A weather layer failing never takes the host app down - see MapController.reportLayerError - but until this callback existed the app had no way to learn it happened, so a missing layer was indistinguishable from one that simply had no data. Observe this to fall back to another product, drop the entry from a layer menu, or attach the driver's own words to a bug report.

Constructors

MapsGLLayerError

constructor(reason: MapsGLLayerError.Reason, layerCode: String?, layerId: String?, message: String, cause: Throwable? = null)

Types

Reason

enum Reason : Enum<MapsGLLayerError.Reason>

The kinds of layer failure the SDK reports.

Properties

cause

val cause: Throwable? = null

The underlying throwable, when there was one. Absent for a refusal, which is a decision rather than a failure.

layerCode

val layerCode: String?

The weather layer code (e.g. "wind-particles"), when the failure is attributable to one; empty or null for layers added outside MapController.addWeatherLayer.

layerId

val layerId: String?

The layer's id in the map's layer stack, when it got as far as being added.

message

val message: String

Human-readable account of the failure. For a rejected shader this carries the driver's own info log, which is usually the only statement of what it objected to.

reason

val reason: MapsGLLayerError.Reason

What kind of failure this is; see Reason.

Functions

toString

open override fun toString(): String

One-line form suitable for a log or a bug report.