com.atakmap.android.routes

Class RoutePointPackage

java.lang.Object

com.atakmap.android.routes.RoutePointPackage

public class RoutePointPackage
extends java.lang.Object

Serves as a data class to provide pertinent details for the points that were generated for a route. A RoutePointPackage can either denote that a route was generated successfully, in which case it holds a list of points, and the point cues for the generated route, or that route generation fails, in which case it holds an error message to be displayed to the user explaining why the route generation has failed.

Constructor Summary

Constructors

Constructor and Description
RoutePointPackage(java.util.List<PointMapItem> routePoints, java.util.Map<java.lang.String,NavigationCue> pointCues) Constructor for a successful route point package
RoutePointPackage(java.lang.String errorMessage) Constructor for a route point package that has yielded an error

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError() Returns the error message that was set for this route point package (if any).
java.util.Map<java.lang.String,NavigationCue>	getPointCues() Returns the point cues if this is successful route point package.
java.util.List<PointMapItem>	getRoutePoints() Returns the points on the route if this is a successful route point package.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoutePointPackage

public RoutePointPackage(java.util.List<PointMapItem> routePoints,
                         java.util.Map<java.lang.String,NavigationCue> pointCues)

Constructor for a successful route point package

Parameters:

routePoints - list of point map items of the route, in order.

pointCues - map from UIDs of point map items on the route to the navigation cues set for those points.

RoutePointPackage

public RoutePointPackage(java.lang.String errorMessage)

Constructor for a route point package that has yielded an error

Method Detail

getRoutePoints

public java.util.List<PointMapItem> getRoutePoints()

Returns the points on the route if this is a successful route point package. Returns null otherwise.

getPointCues

public java.util.Map<java.lang.String,NavigationCue> getPointCues()

Returns the point cues if this is successful route point package. Returns null otherwise. The format of the returned point cues is a map from point map items on the route to the navigation cue associated with that point map item on the route.

getError

public java.lang.String getError()

Returns the error message that was set for this route point package (if any). Returns null otherwise.