WorldWind Kotlin/earth.worldwind.ogc/Wcs201ElevationCoverage

Wcs201ElevationCoverage

open class Wcs201ElevationCoverage : TiledElevationCoverage, WebElevationCoverage

Generates elevations from OGC Web Coverage Service (WCS) version 2.0.1. Wcs201ElevationCoverage requires the WCS service address, coverage name, and coverage bounding sector. Get Coverage requests generated for retrieving data use the WCS version 2.0.1 protocol and are limited to the "image/tiff" format and the EPSG:4326 coordinate system. Wcs201ElevationCoverage does not perform version negotiation and assumes the service supports the format and coordinate system parameters detailed here. The subset CRS is configured as EPSG:4326 and the axis labels are set as "Lat" and "Long". The scaling axis labels are set as: http://www.opengis.net/def/axis/OGC/1/i and http://www.opengis.net/def/axis/OGC/1/j

Constructors

constructor(serviceAddress: String, coverageName: String, outputFormat: String, sector: Sector, resolution: Angle)

Constructs a Web Coverage Service (WCS) elevation coverage with specified WCS configuration values.

Types

Companion

object Companion

Properties

cachedSourceInfo

val TiledElevationCoverage.cachedSourceInfo: CachedSourceInfo?

See TiledImageLayer.cachedSourceInfo — same shape for elevation coverages. The cache provider here is the elevation source factory, not a tile-source decorator.

cacheRetrievalQueueSize

var cacheRetrievalQueueSize: Int

Concurrent cache-only reads allowed. Generous vs retrievalQueueSize: cache reads are cheap local I/O and must get their own budget separate from the network-retrieval budget, so a slow network DEM fetch holding the network slots can't stall cached tiles behind it.

coverageName

override val coverageName: String

The technical name of the desired coverage

displayName

open override var displayName: String?

Human-readable elevation coverage name

elevationSourceFactory

var elevationSourceFactory: ElevationSourceFactory

isEnabled

open override var isEnabled: Boolean

Determines if current elevation coverage should be processed during rendering

isFloat

open val isFloat: Boolean

Output-format heuristic — "what does this format type carry in its bytes": true for BIL32 / GeoTIFF / DTED, false for BIL16 and other 16-bit-integer formats.

outputFormat

override val outputFormat: String

Expected data output format

retrievalQueueSize

var retrievalQueueSize: Int

Controls how many concurrent tile requests are allowed for this coverage.

sector

override val sector: Sector

Elevation content bounding sector

serviceAddress

override val serviceAddress: String

The service address

serviceMetadata

override val serviceMetadata: String?

Descriptive information about service capabilities

serviceType

override val serviceType: String

Type of the service

tileMatrixSet

var tileMatrixSet: TileMatrixSet

timestamp

open override val timestamp: Long

Last elevation update timestamp

type

val type: String

Unique identifier of the coverage type, defined by elevation source factory content type

Functions

clear

open override fun clear()

Clears elevation runtime data

clone

open override fun clone(): Wcs201ElevationCoverage

contentEntry

fun TiledElevationCoverage.contentEntry(contentManager: ContentManager? = null): ContentEntry?

Elevation-coverage counterpart of TiledImageLayer.contentEntry — coverages have no "self-contained file factory" case in the current factory set, so this is just the ContentManager adapter behind a uniform call site.

getElevation

open override fun getElevation(latitude: Angle, longitude: Angle, retrieve: Boolean): Float

Gets elevation at specified location

getElevationGrid

open override fun getElevationGrid(gridSector: Sector, gridWidth: Int, gridHeight: Int, result: FloatArray)

Gets elevation values for the specified sector with required width and height resolution

getElevationLimits

open override fun getElevationLimits(sector: Sector, result: FloatArray)

Gets elevation limits at specified sector

getUserProperty

open override fun getUserProperty(key: Any): Any?

Gets optional user property

hasUserProperty

open override fun hasUserProperty(key: Any): Boolean

Checks optional user property exists

isChangedSince

open override fun isChangedSince(time: Long, sector: Sector): Boolean

Checks if coverage data influencing the specified sector could have changed after the specified timestamp

launchBulkRetrieval

fun TiledElevationCoverage.launchBulkRetrieval(sector: Sector, resolution: ClosedRange<Angle>, scope: CoroutineScope = GlobalScope, maxRetries: Int = 3, retryTimeoutShort: Duration = 5.seconds, retryTimeoutLong: Duration = 15.seconds, overrideCache: Boolean = false, onProgress: (downloaded: Long, skipped: Long, total: Long) -> Unit? = null): Job?

Download every elevation tile that intersects sector across every tile matrix whose pixel-resolution falls in resolution, writing each tile through to the coverage's cache.

putUserProperty

open override fun putUserProperty(key: Any, value: Any): Any?

Puts optional user property

removeUserProperty

open override fun removeUserProperty(key: Any): Any?

Removes optional user property

setOfflineOnly

fun TiledElevationCoverage.setOfflineOnly(offlineOnly: Boolean = true)

See setOfflineOnly on TiledImageLayer. The OfflineToggleable lives on the coverage's elevationSourceFactory (the platform-specific CachedElevationSourceFactory / GpkgCachedElevationSourceFactory both implement it). No-op when the coverage is wired to a network-only factory.

setupCoverageCache

fun setupCoverageCache(capacity: Long, lowWater: Long = (capacity * 0.75).toLong())

Setup custom coverage cache size according to device capabilities and user needs.