UpcomingRouteAlert

class UpcomingRouteAlert

Holds the route alert and the distance to the point where the alert occurs, or start an alert if it has length.

Parameters

routeAlert

route alert

distanceToStart

distance to the start of the alert. If the alert has a length, and we've passed the start point, this value will be negative until we cross the finish point of the alert's geometry. This negative value, together with RouteAlertGeometry.length can be used to calculate the distance since the start of an alert.

Types

Builder
Link copied to clipboard
class Builder(routeAlert: RouteAlert, distanceRemaining: Double)
Use to create a new instance.

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Returns a hash code value for the object.
toBuilder
Link copied to clipboard
fun toBuilder(): UpcomingRouteAlert.Builder
Transform this object into a builder to mutate the values.
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

distanceToStart
Link copied to clipboard
val distanceToStart: Double
distance to the start of the alert.
routeAlert
Link copied to clipboard
val routeAlert: RouteAlert
route alert