com.atakmap.android.routes

Interface RoutePlannerInterface

public interface RoutePlannerInterface

Method Summary

Modifier and Type	Method and Description
boolean	canRouteAroundRegions() Gets whether or not the planner is capable of supporting routing around regions.
java.lang.String	getDescriptiveName() Gets the descriptive name of the planner.
RoutePlannerOptionsView	getNavigationOptions(android.app.AlertDialog parent) Gets any additional options for the planner that are needed at the time of navigating a route.
RoutePlannerOptionsView	getOptionsView(android.app.AlertDialog parent) Gets the additional options specific for the planner that may effect the results.
RouteGenerationTask	getRouteGenerationTask(RouteGenerationTask.RouteGenerationEventListener routeGenerationEventListener) Gets the RouteGenerationTask for this planner that is run when initially generating a route.
boolean	isNetworkRequired() Planner requires a network to be used.
boolean	isRerouteCapable() Gets whether or not the planner is capable of supporting re-routing.

Method Detail

getDescriptiveName

java.lang.String getDescriptiveName()

Gets the descriptive name of the planner.

Returns:

the descriptive name of the planner

isNetworkRequired

boolean isNetworkRequired()

Planner requires a network to be used.

Returns:

true if an active network is required.

getRouteGenerationTask

RouteGenerationTask getRouteGenerationTask(RouteGenerationTask.RouteGenerationEventListener routeGenerationEventListener)

Gets the RouteGenerationTask for this planner that is run when initially generating a route.

Parameters:

routeGenerationEventListener - The listener that should be associated with this task.

Returns:

A RouteGenerationTask for this planner.

getOptionsView

RoutePlannerOptionsView getOptionsView(android.app.AlertDialog parent)

Gets the additional options specific for the planner that may effect the results.

getNavigationOptions

RoutePlannerOptionsView getNavigationOptions(android.app.AlertDialog parent)

Gets any additional options for the planner that are needed at the time of navigating a route.

Returns:

Null if the planner does not support additional options, the options otherwise

isRerouteCapable

boolean isRerouteCapable()

Gets whether or not the planner is capable of supporting re-routing.

canRouteAroundRegions

boolean canRouteAroundRegions()

Gets whether or not the planner is capable of supporting routing around regions.