RoutePlace (API Reference)
Class RoutePlace
The location information.
-
Field Summary
FieldsModifier and TypeFieldDescriptionEstimated battery charge in kWh for electric vehicles when leaving this place.Charging station data for electric vehicles.Location of the Points of Interest (PoI) to be displayed in the visualization.Identifier of a public transit place if available.Map-matched geographic coordinates.Name of a public transit place if available.User-defined geographic coordinates.Platform name or number of a public transit place if available.Side of destination: left, right or undefined.The type of the route place.If available, this index corresponds to the waypoint in the original user-defined waypoint list. -
Constructor Summary
ConstructorsConstructorDescriptionRoutePlace(RoutePlaceType type, GeoCoordinates mapMatchedCoordinates) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionbooleaninthashCode()booleanChecks whether theRoutePlaceis off-road or not.
-
Field Details
-
type
The type of the route place.
-
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
User-defined geographic coordinates. If not available, it means this place was added during route calculation.
-
mapMatchedCoordinates
Map-matched geographic coordinates.
-
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
Estimated battery charge in kWh for electric vehicles when leaving this place. Available only if the route was calculated with
ElectricVehicleOptions.ensureReachability=true. -
chargingStation
Charging station data for electric vehicles.
-
name
Name of a public transit place if available.
-
id
Identifier of a public transit place if available.
-
platform
Platform name or number of a public transit place if available.
-
sideOfDestination
Side of destination: left, right or undefined.
nullfor transit sections and for origin points.UNDEFINEDiforiginalCoordinatesare not identified or too close to the road.
-
-
Constructor Details
-
RoutePlace
Creates a new instance.
- Parameters:
type-The type of the route place.
mapMatchedCoordinates-Map-matched geographic coordinates.
-
-
Method Details
-
equals
-
hashCode
public int hashCode() -
isOffRoad
public boolean isOffRoad()Checks whether the
RoutePlaceis off-road or not.- Returns:
trueif theRoutePlaceis off-road,falseotherwise.
-