Package com.esri.arcgisruntime.tasks.networkanalysis

Class RouteResult

java.lang.Object

com.esri.arcgisruntime.tasks.networkanalysis.RouteResult

public final class RouteResult
extends Object

Represents the result of RouteTask.solveRouteAsync(RouteParameters). The result is a collection of computed routes, barriers used in the computation, and messages generated during the process.

Since:

100.0.0

Method Summary

Modifier and Type	Method	Description
String	getDirectionsLanguage()	Gets the language used when computing directions.
List<String>	getMessages()	Gets the informational messages that were generated while computing routes.
List<PointBarrier>	getPointBarriers()	Gets the point barriers used in the route computation.
List<PolygonBarrier>	getPolygonBarriers()	Gets the polygon barriers used in the route computation.
List<PolylineBarrier>	getPolylineBarriers()	Gets the polyline barriers used in the route computation.
List<Route>	getRoutes()	Gets the List of routes.

Methods inherited from class java.lang.Object

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

Method Detail

getDirectionsLanguage

public String getDirectionsLanguage()

Gets the language used when computing directions. The list of supported languages can be obtained by calling RouteTaskInfo.getSupportedLanguages().

Returns:

the directions language

Since:

100.0.0

getMessages

public List<String> getMessages()

Gets the informational messages that were generated while computing routes.

Returns:

an unmodifiable list of the messages

Since:

100.0.0

getPointBarriers

public List<PointBarrier> getPointBarriers()

Gets the point barriers used in the route computation. Only available if RouteParameters.setReturnPointBarriers(boolean) is set.

Returns:

an unmodifiable list of the point barriers

Since:

100.0.0

See Also:

RouteParameters.getPointBarriers(), RouteParameters.setPointBarriers(ArcGISFeatureTable, QueryParameters)

getPolylineBarriers

public List<PolylineBarrier> getPolylineBarriers()

Gets the polyline barriers used in the route computation. Only available if RouteParameters.setReturnPolylineBarriers(boolean) is set.

Returns:

an unmodifiable list of the polyline barriers

Since:

100.0.0

See Also:

RouteParameters.getPolylineBarriers(), RouteParameters.setPolylineBarriers(ArcGISFeatureTable, QueryParameters)

getPolygonBarriers

public List<PolygonBarrier> getPolygonBarriers()

Gets the polygon barriers used in the route computation. Only available if RouteParameters.setReturnPolygonBarriers(boolean) is set.

Returns:

an unmodifiable list of the polygon barriers

Since:

100.0.0

See Also:

RouteParameters.getPolygonBarriers(), RouteParameters.setPolygonBarriers(ArcGISFeatureTable, QueryParameters)

getRoutes

public List<Route> getRoutes()

Gets the List of routes. Each element represents an independent route with its own driving directions. Stops are grouped into different routes based on Stop.setRouteName(String)

Returns:

an unmodifiable list of the routes

Since:

100.0.0