gpx/org.maplibre.spatialk.gpx/Route

Route

data class Route(val name: String?, val comment: String?, val description: String?, val source: String?, val link: String?, val number: Int?, val type: String?, val points: List<Waypoint>, val extensions: Element? = null)(source)

Represents a route - an ordered list of waypoints representing a series of turn points leading to a destination.

Constructors

constructor(name: String?, comment: String?, description: String?, source: String?, link: String?, number: Int?, type: String?, points: List<Waypoint>, extensions: Element? = null)

Properties

@SerialName(value = "cmt")

val comment: String?

A comment, and/or additional information about the route.

@SerialName(value = "desc")

val description: String?

A text description of the route for user display.

val extensions: Element?

Extension schema elements.

@SerialName(value = "link")

val link: String?

A link to external information about the route.

@SerialName(value = "name")

val name: String?

The GPS name of the route.

@SerialName(value = "number")

val number: Int?

A GPS route number.

@SerialName(value = "rtept")

val points: List<Waypoint>

A list of route points (Waypoint) which are the turning points, intersections, or other critical points in the route.

@SerialName(value = "src")

val source: String?

The source of the data. Recommended to be a URL which provides additional information about the route.

@SerialName(value = "type")

val type: String?

The type of route. This is for categorizing the route and can be user-defined (e.g., "resupply", "scenic").

Functions

fun Route.toGeoJson(): Feature<GeometryCollection<Point>, Route>

Converts this Route to a GeoJSON Feature with a GeometryCollection of Points.