Package com.here.sdk.routing

Class RoutePlace

  • java.lang.Object
    • com.here.sdk.routing.RoutePlace
  • public final class RoutePlace
extends java.lang.Object

    The location information.

    • Field Detail

      • type

        @NonNull
public RoutePlaceType type

        The type of the route place.

      • waypointIndex

        @Nullable
public java.lang.Integer waypointIndex

        If available, this index corresponds to the waypoint in the original user-defined waypoint list. Otherwise, this waypoint was added during route calculation by the system.

      • originalCoordinates

        @Nullable
public GeoCoordinates originalCoordinates

        User-defined geographic coordinates. If not available, it means this place was added during route calculation.

      • mapMatchedCoordinates

        @NonNull
public GeoCoordinates mapMatchedCoordinates

        Map-matched geographic coordinates.

      • displayCoordinates

        @Nullable
public GeoCoordinates displayCoordinates

        Location of the Points of Interest (PoI) to be displayed in the visualization. In the map data, PoI have a set of display coordinates as well as a set of access/routing coordinates. While the access/routing coordinates specify the nearest accessible road network location that can be apart from actual location of the PoI, the display coordinates specify the location of the PoI to be displayed accurately in the visualization.

      • chargeInKilowattHours

        @Nullable
public java.lang.Double chargeInKilowattHours

        Estimated battery charge in kWh for electric vehicles when leaving this place. Available only if the route was calculated with EVCarOptions.ensureReachability = true.

      • chargingStation

        @Nullable
public ChargingStation chargingStation

        Charging station data for electric vehicles.

      • name

        @Nullable
public java.lang.String name

        Name of a public transit place if available.

      • id

        @Nullable
public java.lang.String id

        Identifier of a public transit place if available.

      • platform

        @Nullable
public java.lang.String platform

        Platform name or number of a public transit place if available.

      • sideOfDestination

        @Nullable
public SideOfDestination sideOfDestination

        Side of destination: left, right or undefined. null for transit sections and for origin points. UNDEFINED if originalCoordinates are not identified or too close to the road.

    • Constructor Detail

      • RoutePlace

        public RoutePlace​(@NonNull
                  RoutePlaceType type,
                  @NonNull
                  GeoCoordinates mapMatchedCoordinates)

        Creates a new instance.

        Parameters:
        type -

        The type of the route place.

        mapMatchedCoordinates -

        Map-matched geographic coordinates.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • isOffRoad

        public boolean isOffRoad()

        Checks whether the RoutePlace is off-road or not.

        Returns:

        true if the RoutePlace is off-road, false otherwise.