HERE Android SDK Developer's Guide

CombinedRoute

The class CombinedRoute is a member of com.here.android.mpa.venues3d .

Class Summary

public class CombinedRoute

extends java.lang.Object

Represents route from start to end point.

[For complete information, see the section Class Details]

See also:

IRouteSection

Nested Class Summary

Table 1. Nested Classes in CombinedRoute
Nested Classes

public static final enumeration CombinedRoute.VenueRoutingError

Represents identifiers for routing errors.

Method Summary

Table 2. Methods in CombinedRoute
Methods

public boolean conformsConnectorOptions ()

Returns true if the returned route does no use any accessors set to be avoided in VenueRouteOptions.

public boolean conformsModeOptions ()

Returns true if the result route for every outdoor segment, except to/from parking, is the mode the user has requested in VenueRouteOptions.

public RoutingError getCoreMapError ()

Returns RoutingError, indicating inner core map error.

public BaseLocation getEnd ()

Returns a BaseLocation objects associated with end point of the route.

public VenueRoutingError getError ()

Returns VenueRouthingError indicating route computation result.

public int getLength ()

Returns the length of the route in meters.

public java.util.List <IRouteSection> getRouteSections ()

Returns a list of IRouteSection objects associated with this route instance.

public BaseLocation getStart ()

Returns a BaseLocation objects associated with start point of the route.

public java.util.List <BaseLocation> getWaypoints ()

Returns a list of BaseLocation objects associated with waypoints on the route including start and end points.

Class Details

Represents route from start to end point. The route is split to one or more route sections.

See also:

IRouteSection

Method Details

public boolean conformsConnectorOptions ()

Returns true if the returned route does no use any accessors set to be avoided in VenueRouteOptions.

Sometimes, no route can be created that satisfies all route options set by the user (like: use of elevators, escalators, stairs and ramps). If any of these are set to be avoided, this method can be used to check if the calculated route still uses any of these accessors.

public boolean conformsModeOptions ()

Returns true if the result route for every outdoor segment, except to/from parking, is the mode the user has requested in VenueRouteOptions.

public RoutingError getCoreMapError ()

Returns RoutingError, indicating inner core map error. This function should be used only when the method getError returns the error code CORE_MAP .

public BaseLocation getEnd ()

Returns a BaseLocation objects associated with end point of the route.

Returns:

Last point of route (flag anchor).

public VenueRoutingError getError ()

Returns VenueRouthingError indicating route computation result.

public int getLength ()

Returns the length of the route in meters.

public java.util.List <IRouteSection> getRouteSections ()

Returns a list of IRouteSection objects associated with this route instance. This information can be used to check type of turn-by-turn information available for each route sections of this combined route instance.

Returns:

A list of route sections.

public BaseLocation getStart ()

Returns a BaseLocation objects associated with start point of the route.

Returns:

First point of route (flag anchor).

public java.util.List <BaseLocation> getWaypoints ()

Returns a list of BaseLocation objects associated with waypoints on the route including start and end points.

Returns:

List of waypoint point on route (flag anchors).