gpx/org.maplibre.spatialk.gpx/Waypoint

Waypoint

data class Waypoint(val latitude: Double, val longitude: Double, val elevation: Double? = null, val timestamp: Instant? = null, val magneticVariation: Double? = null, val geoIdHeight: Double? = null, val name: String? = null, val comment: String? = null, val description: String? = null, val source: String? = null, val link: Link? = null, val symbol: String? = null, val type: String? = null, val fix: String? = null, val satelliteCount: Int? = null, val horizontalDop: Double? = null, val verticalDop: Double? = null, val positionDop: Double? = null, val dgpsAge: Double? = null, val dgpsId: Double? = null, val extensions: Element? = null)(source)

Represents a waypoint, point of interest, or named feature on a map. This corresponds to the wptType in the GPX 1.1 schema.

A waypoint is a single point on the earth, defined by its latitude and longitude. It can optionally include other information such as elevation, time, and descriptive details.

Constructors

constructor(latitude: Double, longitude: Double, elevation: Double? = null, timestamp: Instant? = null, magneticVariation: Double? = null, geoIdHeight: Double? = null, name: String? = null, comment: String? = null, description: String? = null, source: String? = null, link: Link? = null, symbol: String? = null, type: String? = null, fix: String? = null, satelliteCount: Int? = null, horizontalDop: Double? = null, verticalDop: Double? = null, positionDop: Double? = null, dgpsAge: Double? = null, dgpsId: Double? = null, extensions: Element? = null)

Properties

@SerialName(value = "cmt")

val comment: String?

GPS waypoint comment.

@SerialName(value = "desc")

val description: String?

A text description of the element.

@SerialName(value = "ageofdgpsdata")

val dgpsAge: Double?

Number of seconds since last DGPS update.

@SerialName(value = "dgpsid")

val dgpsId: Double?

ID of DGPS station used in differential correction.

@SerialName(value = "ele")

val elevation: Double?

Elevation of the point in meters.

val extensions: Element?

Extension schema elements.

val fix: String?

Type of GPS fix. 'none' means no fix. '2d' and '3d' are just estimates of quality.

@SerialName(value = "geoidheight")

val geoIdHeight: Double?

Height of geoid (mean sea level) above WGS84 earth ellipsoid, in meters.

@SerialName(value = "hdop")

val horizontalDop: Double?

Horizontal dilution of precision.

@SerialName(value = "lat")

val latitude: Double

The latitude of the point. Decimal degrees, WGS84 datum. (Required)

val link: Link?

Link to additional information about the waypoint.

@SerialName(value = "lon")

val longitude: Double

The longitude of the point. Decimal degrees, WGS84 datum. (Required)

magneticVariation

@SerialName(value = "magvar")

val magneticVariation: Double?

Magnetic variation (in degrees) at the point.

val name: String?

The GPS name of the waypoint.

@SerialName(value = "pdop")

val positionDop: Double?

Position dilution of precision.

@SerialName(value = "sat")

val satelliteCount: Int?

Number of satellites used to calculate the GPX fix.

@SerialName(value = "src")

val source: String?

Source of data. Included to give user some idea of reliability and accuracy of data.

@SerialName(value = "sym")

val symbol: String?

Text of GPS symbol name.

@Serializable(with = UtcDefaultInstantSerializer::class)

@SerialName(value = "time")

val timestamp: Instant?

The time of the waypoint creation.

val type: String?

Type of waypoint.

@SerialName(value = "vdop")

val verticalDop: Double?

Vertical dilution of precision.

Functions

fun Waypoint.toGeoJson(): Feature<Point, Waypoint>

Converts a Waypoint into a GeoJSON Feature with a Point geometry.