Poi

class Poi(val name: String, val coordinate: GeoPoint, val categoryId: Long, val categoryName: String, val detourTime: Duration? = null, val detourDistance: Distance? = null, val detourOffset: Distance? = null)

Represents a Point of Interest (POI) with associated metadata.

A Poi encapsulates the data required to plot a point on a map, including its coordinates and additional information such as its category and potential detour metrics.

Constructors

Link copied to clipboard
constructor(name: String, coordinate: GeoPoint, categoryId: Long, categoryName: String, detourTime: Duration? = null, detourDistance: Distance? = null, detourOffset: Distance? = null)

Properties

Link copied to clipboard

An identifier that represents the category of the POI. This could be used to differentiate between types of POIs, such as restaurants, parks, etc.

Link copied to clipboard

The name associated with the category of the Poi.

Link copied to clipboard

The geographical coordinates that determine the `exact location of the Poi on a map.

Link copied to clipboard

An optional measurement that represents the distance required to detour to this POI from a specific route. If not provided, it defaults to null.

Link copied to clipboard
val detourOffset: Distance? = null

An optional measurement representing the distance from the starting point of a route to where a detour to the Poi begins. If not provided, it defaults to null.

Link copied to clipboard
val detourTime: Duration? = null

An optional measurement that represents the time required to detour to this POI from a specific route. If not provided, it defaults to null.

Link copied to clipboard

The name or title of the Point of Interest. For instance, "Eiffel Tower" or "Central Park".

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks if this Poi object is equal to another object.

Link copied to clipboard
open override fun hashCode(): Int

Generates a hash code for this Poi object.