public final class RoutePlan
extends java.lang.Object
GeoCoordinate
.Constructor and Description |
---|
RoutePlan() |
Modifier and Type | Method and Description |
---|---|
RoutePlan |
addWaypoint(GeoCoordinate point)
Adds a waypoint to the plan.
|
RouteOptions |
getRouteOptions()
Gets the route options.
|
GeoCoordinate |
getWaypointAt(int index)
Gets a waypoint at a specified index.
|
int |
getWaypointCount()
Gets the number of waypoints of the route plan.
|
RoutePlan |
insertWaypoint(GeoCoordinate point,
int index)
Inserts a waypoint into a list of existing waypoints.
|
RoutePlan |
removeAllWaypoints()
Removes all waypoints of the route plan.
|
RoutePlan |
removeWaypoint(int index)
Removes a waypoint at a specified index.
|
RoutePlan |
setRouteOptions(RouteOptions options)
Sets the route options.
|
public RoutePlan addWaypoint(GeoCoordinate point)
point
- The GeoCoordinate
waypoint to add.RoutePlan
objectpublic RoutePlan insertWaypoint(GeoCoordinate point, int index)
point
- The waypoint to insertindex
- The index in the range from 0 to the number of already existing waypoints.RoutePlan
objectpublic RoutePlan removeWaypoint(int index)
index
- The zero-based index.RoutePlan
objectpublic RoutePlan removeAllWaypoints()
RoutePlan
objectpublic GeoCoordinate getWaypointAt(int index)
index
- The zero-based index.public int getWaypointCount()
public RoutePlan setRouteOptions(RouteOptions options)
options
. If the
options
object is updated, then this method must be called again for the changes to
be in effect.options
- The RouteOptions
to set.RoutePlan
object.public RouteOptions getRouteOptions()
RouteOptions
options associated with this plan.