EHorizonEdgeMetadata

class EHorizonEdgeMetadata

Edge metadata

NOTE: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.

Parameters

heading

heading when starting to move along the edge. The value is in degrees in the range [0, 360)

length

the Edge's length in meters

functionRoadClass

the edge's RoadClass

speedLimit

max speed of the edge (speed limit) in m/s

speed

average speed along the edge in m/s

ramp

is the edge a ramp?

motorway

is the edge a motorway?

bridge

is the edge a bridge?

tunnel

is the edge a tunnel?

toll

is the edge a toll road?

names

an array of road names

laneCount

the number of lanes on the edge (does not change mid-edge)

meanElevation

mean elevation along the edge in meters

curvature

binned number denoting the curvature degree of the edge (0-15)

countryCodeIso3

ISO 3166-1 alpha-3 country code

countryCodeIso2

the edge's country code (ISO-2 format)

stateCode

a state inside a country (ISO 3166-2)

isRightHandTraffic

true if in the current place/state right-hand traffic is used

isOneWay

true if current edge is one-way. false if left-hand.

roadSurface

type of the road surface.

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Regenerate whenever a change is made
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Regenerate whenever a change is made
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

bridge
Link copied to clipboard
val bridge: Boolean
is the edge a bridge?
countryCodeIso2
Link copied to clipboard
val countryCodeIso2: String?
the edge's country code (ISO-2 format)
countryCodeIso3
Link copied to clipboard
val countryCodeIso3: String?
ISO 3166-1 alpha-3 country code
curvature
Link copied to clipboard
val curvature: Byte
binned number denoting the curvature degree of the edge (0-15)
functionRoadClass
Link copied to clipboard
val functionRoadClass: String
the edge's RoadClass
heading
Link copied to clipboard
val heading: Double
heading when starting to move along the edge.
isOneWay
Link copied to clipboard
val isOneWay: Boolean
true if current edge is one-way.
isRightHandTraffic
Link copied to clipboard
val isRightHandTraffic: Boolean
true if in the current place/state right-hand traffic is used
laneCount
Link copied to clipboard
val laneCount: Byte?
the number of lanes on the edge (does not change mid-edge)
length
Link copied to clipboard
val length: Double
the Edge's length in meters
meanElevation
Link copied to clipboard
val meanElevation: Double?
mean elevation along the edge in meters
motorway
Link copied to clipboard
val motorway: Boolean
is the edge a motorway?
names
Link copied to clipboard
val names: List<RoadName>
an array of road names
ramp
Link copied to clipboard
val ramp: Boolean
is the edge a ramp?
roadSurface
Link copied to clipboard
val roadSurface: String
type of the road surface.
speed
Link copied to clipboard
val speed: Double
average speed along the edge in m/s
speedLimit
Link copied to clipboard
val speedLimit: Double?
max speed of the edge (speed limit) in m/s
stateCode
Link copied to clipboard
val stateCode: String?
a state inside a country (ISO 3166-2)
toll
Link copied to clipboard
val toll: Boolean
is the edge a toll road?
tunnel
Link copied to clipboard
val tunnel: Boolean
is the edge a tunnel?