public class ClosestFacilityParameters
extends com.google.gwt.core.client.JavaScriptObject
Modifier and Type | Class and Description |
---|---|
static class |
ClosestFacilityParameters.AttributeParameter |
Modifier and Type | Method and Description |
---|---|
static ClosestFacilityParameters |
create()
Creates a new ClosestFacilityParameters object
|
com.google.gwt.core.client.JsArrayString |
getAccumulateAttributes()
The list of network attribute names to be accumulated with the analysis, i.e.,which attributes should be returned as part of the response.
|
com.google.gwt.core.client.JsArray<ClosestFacilityParameters.AttributeParameter> |
getAttributeParameterValues()
An array of attribute parameter values that determine which network elements can be used by a vehicle
|
double |
getDefaultCutoff()
The cutoff value used to determine when to stop traversing.
|
int |
getDefaultTargetFacilityCount()
The number of facilities to find.
|
java.lang.String |
getDirectionsLanguage()
The language used when computing directions.
|
java.lang.String |
getDirectionsLengthUnits()
The length units used when computing directions.
|
java.lang.String |
getDirectionsTimeAttribute()
The name of the attribute field that contains the drive time values.
|
DataLayer |
getFacilitiesAsDataLayer()
The set of facilities loaded as network locations during analysis.
|
FeatureSet |
getFacilitiesAsFeatureSet()
The set of facilities loaded as network locations during analysis.
|
java.lang.String |
getImpedenceAttribute()
The network attribute field name used as the impedence attribute during
analysis.
|
DataLayer |
getIncidentsAsDataLayer()
The set of incidents loaded as network locations during analysis.
|
FeatureSet |
getIncidentsAsFeatureSet()
The set of incidents loaded as network locations during analysis.
|
int |
getOutputGeometryPrecision()
The output geometry precision.
|
java.lang.String |
getOutputGeometryPrecisionUnits()
The units of the output geometry precision.
|
java.lang.String |
getOutputLines()
The type of output lines to be generated in the result.
|
SpatialReference |
getOutSpatialReference()
The well-known id of the spatial reference for the geometries returned with the analysis results.
|
DataLayer |
getPointBarriersAsDataLayer()
The set of point barriers loaded as network locations during analysis.
|
FeatureSet |
getPointBarriersAsFeatureSet()
The set of point barriers loaded as network locations during analysis.
|
DataLayer |
getPolygonBarriersAsDataLayer()
The set of polygon barriers loaded as network locations during analysis.
|
FeatureSet |
getPolygonBarriersAsFeatureSet()
The set of polygon barriers loaded as network locations during analysis.
|
DataLayer |
getPolylineBarriersAsDataLayer()
The set of polyline barriers loaded as network locations during analysis.
|
FeatureSet |
getPolylineBarriersAsFeatureSet()
The set of polyline barriers loaded as network locations during analysis.
|
com.google.gwt.core.client.JsArrayString |
getRestrictionAttributes()
The list of network attribute names to be used as restrictions with the analysis.
|
java.lang.String |
getRestrictUTurns()
Specifies how U-Turns should be handled.
|
boolean |
getReturnPolylineBarriers()
If true, polyline barriers will be returned in the barriers property of the ClosestFacilitySolveResult.
|
com.google.gwt.core.client.JsDate |
getTimeOfDay()
The arrival or departure date and time.
|
java.lang.String |
getTimeOfDayUsage()
Defines the way the timeOfDay value is used.
|
java.lang.String |
getTravelDirection()
Options for traveling to or from the facility.
|
boolean |
returnDirections()
If true, directions will be generated and returned in the directions property of each RouteResult and RouteSolveResult.
|
boolean |
returnFacilities()
If true, facilities will be returned with the analysis results.
|
boolean |
returnIncidents()
If true, incidents will be returned with the analysis results.
|
boolean |
returnPointBarriers()
If true, barriers will be returned in the barriers property of the ClosestFacilitySolveResult.
|
boolean |
returnPolygonBarriers()
If true, polygon barriers will be returned in the barriers property of the ClosestFacilitySolveResult.
|
boolean |
returnRoutes()
When true, closest facility routes will be generated and returned in the route property of each ClosestFacilityResult and
ClosestFacilitySolveResult.
|
void |
setAccumulateAttributes(java.lang.String[] accumulateAttributes)
Set the accumulate attributes.
|
void |
setAttributeParameterValues(ClosestFacilityParameters.AttributeParameter[] attributeParameterValues)
Set the attribute parameter values.
|
void |
setDefaultCutoff(double defaultCutoff)
Set the default cutoff value.
|
void |
setDefaultTargetFacilityCount(int defaultTargetFacilityCount)
Set the default target facility count.
|
void |
setDirectionsLanguage(java.lang.String directionsLanguage)
Set the directions language
|
void |
setDirectionsLengthUnits(java.lang.String directionsLengthUnits)
Set the directions length units.
|
void |
setDirectionsTimeAttribute(java.lang.String directionsTimeAttribute)
Set the directions time attributes
|
void |
setFacilities(DataLayer facilities)
Set the facilities.
|
void |
setFacilities(FeatureSet facilities)
Set the facilities.
|
void |
setImpedenceAttribute(java.lang.String impedenceAttribute)
Set the impedence attibute.
|
void |
setIncidents(DataLayer incidents)
Set the incidents.
|
void |
setIncidents(FeatureSet incidents)
Set the incidents.
|
void |
setOutputGeometryPrecision(int outputGeometryPrecision)
Set the output geometry precision
|
void |
setOutputGeometryPrecisionUnits(java.lang.String outputGeometryPrecisionUnits)
Set the output geometry precision units
|
void |
setOutputLines(java.lang.String outputLines)
Set the output lines.
|
void |
setOutSpatialReference(SpatialReference outSpatialReference)
Set the out spatial reference.
|
void |
setPointBarriers(DataLayer pointBarriers)
Set the point Barriers
|
void |
setPointBarriers(FeatureSet pointBarriers)
Set the point Barriers
|
void |
setPolygonBarriers(DataLayer polygonBarriers)
Set the polygon barriers
|
void |
setPolygonBarriers(FeatureSet polygonBarriers)
Set the polygon barriers
|
void |
setPolylineBarriers(DataLayer polylineBarriers)
Set the polyline barriers.
|
void |
setPolylineBarriers(FeatureSet polylineBarriers)
Set the polyline barriers.
|
void |
setRestrictionAttributes(java.lang.String[] restrictionAttributes)
Set the restricition attributes
|
void |
setRestrictUTurns(java.lang.String restrictUTurns)
Set restrict turns.
|
void |
setReturnDirections(boolean returnDirections)
Set return directions value.
|
void |
setReturnFacilities(boolean returnFacilities)
Set return facilities value.
|
void |
setReturnIncidents(boolean returnIncidents)
Set return incidents value.
|
void |
setReturnPointBarriers(boolean returnPointBarriers)
Set the return point barriers value.
|
void |
setReturnPolygonBarriers(boolean returnPolygonBarriers)
Set the return polygon barriers value.
|
void |
setReturnPolylineBarriers(boolean returnPolylineBarriers)
Set the return polyline barriers value.
|
void |
setReturnRoutes(boolean returnRoutes)
Set the return routes values.
|
void |
setTimeOfDay(com.google.gwt.core.client.JsDate timeOfDay)
Set timeOfDay parameter.
|
void |
setTimeOfDayUsage(java.lang.String timeOfDayUsage)
Set timeOfDayUsage parameter.
|
void |
setTravelDirection(java.lang.String travelDirection)
Set the travel direction.
|
void |
setUseHierarchy(boolean useHierarchy)
Set if the hierarchy attribute should be used.
|
boolean |
useHierarchy()
If true, the hierarchy attribute for the network will be used in analysis.
|
public static ClosestFacilityParameters create()
public final void setAccumulateAttributes(java.lang.String[] accumulateAttributes)
accumulateAttributes
- - The list of network attribute names to be accumulated with the analysis,
i.e.,which attributes should be returned as part of the response.public final com.google.gwt.core.client.JsArrayString getAccumulateAttributes()
public final void setAttributeParameterValues(ClosestFacilityParameters.AttributeParameter[] attributeParameterValues)
attributeParameterValues
- - An array of attribute parameter values that determine which network elements can be used by a vehiclepublic final com.google.gwt.core.client.JsArray<ClosestFacilityParameters.AttributeParameter> getAttributeParameterValues()
public final void setDefaultCutoff(double defaultCutoff)
defaultCutoff
- - The cutoff value used to determine when to stop traversing.public final double getDefaultCutoff()
public final void setDefaultTargetFacilityCount(int defaultTargetFacilityCount)
defaultTargetFacilityCount
- - The number of facilities to find.public final int getDefaultTargetFacilityCount()
public final void setDirectionsLanguage(java.lang.String directionsLanguage)
directionsLanguage
- - The language used when computing directions. If not specified the task will use the language
defined in the network layer used by the RouteTask. The default language defined by the NAServer is en_US, the server
administrator is responsible for adding additional languages.public final java.lang.String getDirectionsLanguage()
public final void setDirectionsLengthUnits(java.lang.String directionsLengthUnits)
directionsLengthUnits
- - The length units used when computing directions. If not specified the task will use the value defined by the routing network
layer is used. Possible values are "esriFeet", "esriKilometers","esriMeters", "esriMiles","esriNauticalMiles" and "esriYards".public final java.lang.String getDirectionsLengthUnits()
public final void setDirectionsTimeAttribute(java.lang.String directionsTimeAttribute)
directionsTimeAttribute
- - The name of the attribute field that contains the drive time values. If not specified the task
will use the attribute field defined by the routing network layer.public final java.lang.String getDirectionsTimeAttribute()
public final void setFacilities(DataLayer facilities)
facilities
- - The set of facilities loaded as network locations during analysis.public final void setFacilities(FeatureSet facilities)
facilities
- - The set of facilities loaded as network locations during analysis.public final DataLayer getFacilitiesAsDataLayer()
public final FeatureSet getFacilitiesAsFeatureSet()
public final void setImpedenceAttribute(java.lang.String impedenceAttribute)
impedenceAttribute
- - The network attribute field name used as the impedence attribute during
analysis. If not specified the default value defined by the routing network layer. Valid values include any
attribute name listed in the Service Directory under Network Dataset > Network Attributes with a Usage
Type of esriNauTCost. Specify none to indicate that no network attributes should be used for impedence.
If you specify an empty string the default value defined by the service will be used.public final java.lang.String getImpedenceAttribute()
public final void setIncidents(DataLayer incidents)
incidents
- - The set of incidents loaded as network locations during analysis.public final void setIncidents(FeatureSet incidents)
incidents
- - The set of incidents loaded as network locations during analysis.public final DataLayer getIncidentsAsDataLayer()
public final FeatureSet getIncidentsAsFeatureSet()
public final void setOutputGeometryPrecision(int outputGeometryPrecision)
outputGeometryPrecision
- - The output geometry precision. When 0, no generalization of
the output geometry is performed. Positive values represent the MaximumAllowableOffset parameter used by generalize.public final int getOutputGeometryPrecision()
public final void setOutputGeometryPrecisionUnits(java.lang.String outputGeometryPrecisionUnits)
outputGeometryPrecisionUnits
- - The units of the output geometry precision. The default value is esriUnknownUnits.public final java.lang.String getOutputGeometryPrecisionUnits()
public final void setOutputLines(java.lang.String outputLines)
outputLines
- - The type of output lines to be generated in the result. The default is as defined in the
specific routing network layer used in your RouteTask. See NAOutputLine for a list of valid values.public final java.lang.String getOutputLines()
public final void setOutSpatialReference(SpatialReference outSpatialReference)
outSpatialReference
- - he well-known id of the spatial reference for the geometries returned with the analysis
results. If the outSpatialReference is not specified, the geometries are returned in the spatial reference of the map.public final SpatialReference getOutSpatialReference()
public final void setPointBarriers(DataLayer pointBarriers)
pointBarriers
- - The set of point barriers loaded as network locations during analysis.public final void setPointBarriers(FeatureSet pointBarriers)
pointBarriers
- - The set of point barriers loaded as network locations during analysis.public final DataLayer getPointBarriersAsDataLayer()
public final FeatureSet getPointBarriersAsFeatureSet()
public final void setPolygonBarriers(DataLayer polygonBarriers)
polygonBarriers
- - The set of polygon barriers loaded as network locations during analysis.public final void setPolygonBarriers(FeatureSet polygonBarriers)
polygonBarriers
- - The set of polygon barriers loaded as network locations during analysis.public final DataLayer getPolygonBarriersAsDataLayer()
public final FeatureSet getPolygonBarriersAsFeatureSet()
public final void setPolylineBarriers(DataLayer polylineBarriers)
polylineBarriers
- - The set of polyline barriers loaded as network locations during analysis.public final void setPolylineBarriers(FeatureSet polylineBarriers)
polylineBarriers
- - The set of polyline barriers loaded as network locations during analysis.public final DataLayer getPolylineBarriersAsDataLayer()
public final FeatureSet getPolylineBarriersAsFeatureSet()
public final void setRestrictionAttributes(java.lang.String[] restrictionAttributes)
restrictionAttributes
- - The list of network attribute names to be used as restrictions with the analysis. The default is as
defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under
Network Dataset > Network Attributes. You can also specify a value of none to indicate that no network attributes should be
used as restrictions. If you specify an empty array, it will default to the default of the service.public final com.google.gwt.core.client.JsArrayString getRestrictionAttributes()
public final void setRestrictUTurns(java.lang.String restrictUTurns)
restrictUTurns
- - Specifies how U-Turns should be handled. The default is as defined in the specific routing network
layer used in your RouteTask. See NAUTurn for a list of valid values.public final java.lang.String getRestrictUTurns()
public final void setReturnDirections(boolean returnDirections)
returnDirections
- - If true, directions will be generated and returned in the directions property
of each RouteResult and RouteSolveResult. Default value is false.public final boolean returnDirections()
public final void setReturnFacilities(boolean returnFacilities)
returnFacilities
- - If true, facilities will be returned with the analysis results. Default values is false.public final boolean returnFacilities()
public final void setReturnIncidents(boolean returnIncidents)
returnIncidents
- - If true, incidents will be returned with the analysis results. Default value is false.public final boolean returnIncidents()
public final void setReturnPointBarriers(boolean returnPointBarriers)
returnPointBarriers
- - If true, barriers will be returned in the barriers property of the ClosestFacilitySolveResult. Default value is false.public final boolean returnPointBarriers()
public final void setReturnPolygonBarriers(boolean returnPolygonBarriers)
returnPolygonBarriers
- - If true, polygon barriers will be returned in the barriers property of the ClosestFacilitySolveResult. Default value is false.public final boolean returnPolygonBarriers()
public final void setReturnPolylineBarriers(boolean returnPolylineBarriers)
returnPolylineBarriers
- - If true, polyline barriers will be returned in the barriers property of the ClosestFacilitySolveResult. Default value is false.public final boolean getReturnPolylineBarriers()
public final void setReturnRoutes(boolean returnRoutes)
returnRoutes
- - When true, closest facility routes will be generated and returned in the route property of each
ClosestFacilityResult and ClosestFacilitySolveResult. Default value is true.public final boolean returnRoutes()
public final com.google.gwt.core.client.JsDate getTimeOfDay()
public final void setTimeOfDay(com.google.gwt.core.client.JsDate timeOfDay)
timeOfDay
- - The arrival or departure date and time. For example, if the travelDirection is set to TO_FACILITY and
timeOfDayUsage is set to "end" and timeOfDay is set to 8:00 a.m., the returned route(s) will be setup to arrive at the
facility at 8:00 a.m. local time. Requires ArcGIS Server service version 10.1 or greater. (As of v2.6)public final java.lang.String getTimeOfDayUsage()
public final void setTimeOfDayUsage(java.lang.String timeOfDayUsage)
timeOfDayUsage
- - Defines the way the timeOfDay value is used. The default value is defined in the network layer.
Requires ArcGIS Server service version 10.1 or greater. (As of v2.6) Known values: start | endpublic final void setTravelDirection(java.lang.String travelDirection)
travelDirection
- - Options for traveling to or from the facility. Default values are defined by the newtork layer.
See NATravelDirection for a list of valid values.public final java.lang.String getTravelDirection()
public final void setUseHierarchy(boolean useHierarchy)
useHierarchy
- - If true, the hierarchy attribute for the network will be used in analysis. The default
is defined in the routing network layer used by the ClosestFacilityTask.public final boolean useHierarchy()