edu.ucdavis.cstars.client.tasks

Class ClosestFacilitySolveResult

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.ClosestFacilitySolveResult

public class ClosestFacilitySolveResult
extends com.google.gwt.core.client.JavaScriptObject

The result from a ClosestFacilityTask operation. Note: ClosestFacilitySolveResult, and other closest facility related classes, requires ArcGIS Server 10.0 or above and a closest facility layer. A closest facility layer is a layer of type esriNAServerClosestFacilityLayer.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.core.client.JsArray<DirectionsFeatureSet>	getDirections() An array of directions.
com.google.gwt.core.client.JsArray<Point>	getFacilities() An array of points, only returned when ClosestFacilityParameters.returnFacilities is true.
com.google.gwt.core.client.JsArray<Point>	getIncidents() An array of points, only returned when ClosestFacilityParameters.returnIncidents is true.
com.google.gwt.core.client.JsArray<NAMessage>	getMessages() Message received when the solve is complete.
com.google.gwt.core.client.JsArray<Point>	getPointBarriers() The point barriers are an array of points.
com.google.gwt.core.client.JsArray<Polygon>	getPolygonBarriers() he polygon barriers are an array of polygons.
com.google.gwt.core.client.JsArray<Polyline>	getPolylineBarriers() The polyline barriers are an array of polylines.
com.google.gwt.core.client.JsArray<Graphic>	getRoutes() The array of routes.
com.google.gwt.core.client.JsArray<Polyline>	getRoutesAsPolyline() Deprecated.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDirections

public final com.google.gwt.core.client.JsArray<DirectionsFeatureSet> getDirections()

An array of directions. A direction is an instance of esri.tasks.DirectionFeatureSest. Route directions are returned if returnDirections was set to true, the default is false.

Returns:

JsArray

getFacilities

public final com.google.gwt.core.client.JsArray<Point> getFacilities()

An array of points, only returned when ClosestFacilityParameters.returnFacilities is true.

Returns:

JsArray

getIncidents

public final com.google.gwt.core.client.JsArray<Point> getIncidents()

An array of points, only returned when ClosestFacilityParameters.returnIncidents is true.

Returns:

JsArray

getMessages

public final com.google.gwt.core.client.JsArray<NAMessage> getMessages()

Message received when the solve is complete. If a closest facility cannot be solved, the message returned by the server identifies the incident that could not be solved.

Returns:

JsArray

getPointBarriers

public final com.google.gwt.core.client.JsArray<Point> getPointBarriers()

The point barriers are an array of points. They are returned only if ClosestFacilityParameters.returnPointBarriers was set to true (which is not the default). If you send in the point barriers as a featureSet (instead of using DataLayer), you already have the barrers and might not need to request them back from the server.

Returns:

JsArray

getPolygonBarriers

public final com.google.gwt.core.client.JsArray<Polygon> getPolygonBarriers()

he polygon barriers are an array of polygons. They are returned only if ClosestFacilityParameters.returnPolygonBarriers was set to true (which is not the default). If you send in the polygon barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.

Returns:

JsArray

getPolylineBarriers

public final com.google.gwt.core.client.JsArray<Polyline> getPolylineBarriers()

The polyline barriers are an array of polylines. They are returned only if ClosestFacilityParameters.returnPolylineBarriers was set to true (which is not the default). If you send in the polyline barriers as a featureSet (instead of using DataLayer), you already have the barriers and might not need to request them back from the server.

Returns:

JsArray

getRoutesAsPolyline

public final com.google.gwt.core.client.JsArray<Polyline> getRoutesAsPolyline()

Deprecated.

The array of routes. Route features are returned if returnRoutes is true and outputLines does not equal esriNAOutputLineNone. From version 2.0 to 2.5 the type is an array of Polylines. At version 2.6 the type is an array of Graphics.

Returns:

JsArray

getRoutes

public final com.google.gwt.core.client.JsArray<Graphic> getRoutes()

The array of routes. Route features are returned if returnRoutes is true and outputLines does not equal esriNAOutputLineNone. From version 2.0 to 2.5 the type is an array of Polylines. At version 2.6 the type is an array of Graphics.

Returns:

JsArray