ClosestFacilityTaskParameters (ArcGIS_Runtime

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.core.tasks.ags.na
Class ClosestFacilityTaskParameters

java.lang.Object
  com.esri.core.tasks.ags.na.NATaskParameters
      com.esri.core.tasks.ags.na.ClosestFacilityTaskParameters

public class ClosestFacilityTaskParameters
extends NATaskParameters
extends NATaskParameters

Constructor Summary
`ClosestFacilityTaskParameters()`

Method Summary
`String[]`	`getAccumulateAttributeNames()` Returns the list of accumulate attribute names
`AttributeParameterValue[]`	`getAttributeParameterValues()` Returns the list of attribute parameter values
`Double`	`getDefaultCutoff()` Gets the default cutoff value to stop traversing
`Integer`	`getDefaultTargetFacilityCount()` Gets the default number of target facilities to find
`String`	`getDirectionsLanguage()` Returns the language in which to return the directions
`DirectionsLengthUnit`	`getDirectionsLengthUnit()` Returns the Unit type of the length of the directions
`DirectionsOutputType`	`getDirectionsOutputType()` Returns the type in which the directions are output
`String`	`getDirectionsStyleName()` Returns the name of the style in which to return the directions
`String`	`getDirectionsTimeAttributeName()` Returns the name of the directions time attribute
`NAFeatures`	`getFacilities()` Gets the facilities used for the closest facility task
`String`	`getImpedanceAttributeName()` Returns the name of the impedance attribute to use
`NAFeatures`	`getIncidents()` Gets the incidents used for the closest facility task
`Double`	`getOutputGeometryPrecision()` Returns the precision value of the output geometry
`Unit.EsriUnit`	`getOutputGeometryPrecisionUnits()` Returns the unit of the output geometry precision
`NAOutputLine`	`getOutputLines()` Gets the type of output lines of the route
`SpatialReference`	`getOutSpatialReference()` Returns the spatial reference of the output geometry
`NAFeatures`	`getPointBarriers()` Returns the point barriers to avoid while solving
`NAFeatures`	`getPolygonBarriers()` Returns the polygon barriers to avoid while solving
`NAFeatures`	`getPolylineBarriers()` Returns the polyline barriers to avoid while solving
`String[]`	`getRestrictionAttributeNames()` Returns the list of restriction attribute names
`UTurnRestriction`	`getRestrictUTurns()` Returns the type of U turn restriction to use
`Long`	`getTimeOfDay()` Gets the time of day at which to compute the closest facility
`NATimeOfDayUsage`	`getTimeOfDayUsage()` Gets how the time of day should be used (start or end)
`NATravelDirection`	`getTravelDirection()` Gets the travel direction to use for the closest facility task (to or from the facilities)
`Boolean`	`getUseHierarchy()` Gets whether or not to use hierarchy
`boolean`	`isReturnCFRoutes()` Gets whether or not to return closest facility routes
`boolean`	`isReturnDirections()` Gets whether or not to return turn-by-turn directions for the closest facility routes.
`boolean`	`isReturnFacilities()` Gets whether or not to return the facilities used in the closest facility task
`boolean`	`isReturnIncidents()` Gets whether or not to return the incidents used in the closest facility task
`boolean`	`isReturnPointBarriers()` Gets whether or not to return point barriers
`boolean`	`isReturnPolygonBarriers()` Gets whether or not to return polygon barriers
`boolean`	`isReturnPolylineBarriers()` Gets whether or not to return polyline barriers
`boolean`	`isReturnZ()` Gets whether or not to return z values
`void`	`setAccumulateAttributeNames(String[] accumulateAttributeNames)` Sets the list of accumulate attribute names
`void`	`setAttributeParameterValues(AttributeParameterValue[] attributeParameterValues)` Sets the list of attribute parameter values
`void`	`setDefaultCutoff(Double defaultCutoff)` Sets the default cutoff value to stop traversing
`void`	`setDefaultTargetFacilityCount(Integer defaultTargetFacilityCount)` Sets the default number of target facilities to find
`void`	`setDirectionsLanguage(String directionsLanguage)` Sets the language in which to return the directions
`void`	`setDirectionsLengthUnit(DirectionsLengthUnit directionsLengthUnit)` Sets the Unit type of the length of the directions
`void`	`setDirectionsOutputType(DirectionsOutputType directionsOutputType)` Sets the type in which the directions are output
`void`	`setDirectionsStyleName(String directionsStyleName)` Sets the name of the style in which to return the directions
`void`	`setDirectionsTimeAttributeName(String directionsTimeAttributeName)` Sets the name of the directions time attribute
`void`	`setFacilities(NAFeatures facilities)` Sets the facilities used for the closest facility task
`void`	`setImpedanceAttributeName(String impedanceAttributeName)` Sets the name of the impedance attribute to use
`void`	`setIncidents(NAFeatures incidents)` Sets the incidents used for the closest facility task
`void`	`setOutputGeometryPrecision(Double outputGeometryPrecision)` Sets the precision value of the output geometry
`void`	`setOutputGeometryPrecisionUnits(Unit.EsriUnit outputGeometryPrecisionUnit)` Sets the unit of the output geometry precision
`void`	`setOutputLines(NAOutputLine outputLines)` Sets the type of output lines of the route
`void`	`setOutSpatialReference(SpatialReference outSpatialReference)` Sets the spatial reference of the output geometry
`void`	`setPointBarriers(NAFeatures barriers)` Sets the point barriers to avoid while solving
`void`	`setPolygonBarriers(NAFeatures polygonBarriers)` Sets the polygon barriers to avoid while solving
`void`	`setPolylineBarriers(NAFeatures polylineBarriers)` Sets the polyline barriers to avoid while solving
`void`	`setRestrictionAttributeNames(String[] restrictionAttributeNames)` Sets the list of restriction attribute names
`void`	`setRestrictUTurns(UTurnRestriction restrictUTurns)` Sets the type of U turn restriction to use
`void`	`setReturnCFRoutes(boolean returnCFRoutes)` Sets whether or not to return closest facility routes
`void`	`setReturnDirections(boolean returnDirections)` Sets whether or not to return turn-by-turn directions for the closest facility routes.
`void`	`setReturnFacilities(boolean returnFacilities)` Sets whether or not to return the facilities used in the closest facility task
`void`	`setReturnIncidents(boolean returnIncidents)` Sets whether or not to return the incidents used in the closest facility task
`void`	`setReturnPointBarriers(boolean returnPointBarriers)` Sets whether or not to return point barriers
`void`	`setReturnPolygonBarriers(boolean returnPolygonBarriers)` Sets whether or not to return polygon barriers
`void`	`setReturnPolylineBarriers(boolean returnPolylineBarriers)` Sets whether or not to return polyline barriers
`void`	`setReturnZ(boolean returnZ)` Sets whether or not to return z values
`void`	`setTimeOfDay(Long timeOfDay)` Sets the time of day at which to compute the closest facility
`void`	`setTimeOfDayUsage(NATimeOfDayUsage timeOfDayUsage)` Sets how the time of day should be used (start or end)
`void`	`setTravelDirection(NATravelDirection travelDirection)` Sets the travel direction to use for the closest facility task (to or from the facilities)
`void`	`setUseHierarchy(Boolean useHierarchy)` Sets whether or not to use hierarchy

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ClosestFacilityTaskParameters

public ClosestFacilityTaskParameters()

Method Detail

getFacilities

public NAFeatures getFacilities()

Gets the facilities used for the closest facility task

Returns:: the facilities used for the closest facility task

setFacilities

public void setFacilities(NAFeatures facilities)

Sets the facilities used for the closest facility task

Parameters:: facilities - the facilities used for the closest facility task

getIncidents

public NAFeatures getIncidents()

Gets the incidents used for the closest facility task

Returns:: the incidents used for the closest facility task

setIncidents

public void setIncidents(NAFeatures incidents)

Sets the incidents used for the closest facility task

Parameters:: incidents - the incidents used for the closest facility task

isReturnDirections

public boolean isReturnDirections()

Gets whether or not to return turn-by-turn directions for the closest facility routes.

Returns:: whether or not to return turn-by-turn directions

setReturnDirections

public void setReturnDirections(boolean returnDirections)

Sets whether or not to return turn-by-turn directions for the closest facility routes.

Parameters:: returnDirections - true to return turn-by-turn directions

getDirectionsLanguage

public String getDirectionsLanguage()

Returns the language in which to return the directions

Returns:: the language in which to return the directions

setDirectionsLanguage

public void setDirectionsLanguage(String directionsLanguage)

Sets the language in which to return the directions

Parameters:: directionsLanguage - the language in which to return the directions

getDirectionsOutputType

public DirectionsOutputType getDirectionsOutputType()

Returns the type in which the directions are output

Returns:: the type in which the directions are output

setDirectionsOutputType

public void setDirectionsOutputType(DirectionsOutputType directionsOutputType)

Sets the type in which the directions are output

Parameters:: directionsOutputType - the type in which the directions are output

getDirectionsStyleName

public String getDirectionsStyleName()

Returns the name of the style in which to return the directions

Returns:: the name of the style in which to return the directions

setDirectionsStyleName

public void setDirectionsStyleName(String directionsStyleName)

Sets the name of the style in which to return the directions

Parameters:: directionsStyleName - the name of the style in which to return the directions

getDirectionsLengthUnit

public DirectionsLengthUnit getDirectionsLengthUnit()

Returns the Unit type of the length of the directions

Returns:: the Unit type of the length of the directions

setDirectionsLengthUnit

public void setDirectionsLengthUnit(DirectionsLengthUnit directionsLengthUnit)

Sets the Unit type of the length of the directions

Parameters:: directionsLengthUnit - the Unit type of the length of the directions

getDirectionsTimeAttributeName

public String getDirectionsTimeAttributeName()

Returns the name of the directions time attribute

Returns:: the name of the directions time attribute

setDirectionsTimeAttributeName

public void setDirectionsTimeAttributeName(String directionsTimeAttributeName)

Sets the name of the directions time attribute

Parameters:: directionsTimeAttributeName - the name of the directions time attribute

isReturnCFRoutes

public boolean isReturnCFRoutes()

Gets whether or not to return closest facility routes

Returns:: whether or not to return closest facility routes

setReturnCFRoutes

public void setReturnCFRoutes(boolean returnCFRoutes)

Sets whether or not to return closest facility routes

Parameters:: returnCFRoutes - true to return closest facility routes

isReturnFacilities

public boolean isReturnFacilities()

Gets whether or not to return the facilities used in the closest facility task

Returns:: whether or not to return the facilities

setReturnFacilities

public void setReturnFacilities(boolean returnFacilities)

Sets whether or not to return the facilities used in the closest facility task

Parameters:: returnFacilities - true to return the facilities

isReturnIncidents

public boolean isReturnIncidents()

Gets whether or not to return the incidents used in the closest facility task

Returns:: whether or not to return the incidents

setReturnIncidents

public void setReturnIncidents(boolean returnIncidents)

Sets whether or not to return the incidents used in the closest facility task

Parameters:: returnIncidents - true to return the incidents

getDefaultCutoff

public Double getDefaultCutoff()

Gets the default cutoff value to stop traversing

Returns:: the default cutoff value to stop traversing

setDefaultCutoff

public void setDefaultCutoff(Double defaultCutoff)

Sets the default cutoff value to stop traversing

Parameters:: defaultCutoff - the default cutoff value to stop traversing

getDefaultTargetFacilityCount

public Integer getDefaultTargetFacilityCount()

Gets the default number of target facilities to find

Returns:: the default number of target facilities to find

setDefaultTargetFacilityCount

public void setDefaultTargetFacilityCount(Integer defaultTargetFacilityCount)

Sets the default number of target facilities to find

Parameters:: defaultTargetFacilityCount - the default number of target facilities to find

getTravelDirection

public NATravelDirection getTravelDirection()

Gets the travel direction to use for the closest facility task (to or from the facilities)

Returns:: the travel direction to use

setTravelDirection

public void setTravelDirection(NATravelDirection travelDirection)

Sets the travel direction to use for the closest facility task (to or from the facilities)

Parameters:: travelDirection - the travel direction to use

getTimeOfDay

public Long getTimeOfDay()

Gets the time of day at which to compute the closest facility

Returns:: the time of day at which to compute the closest facility

setTimeOfDay

public void setTimeOfDay(Long timeOfDay)

Sets the time of day at which to compute the closest facility

Parameters:: timeOfDay - the time of day at which to compute the closest facility

getTimeOfDayUsage

public NATimeOfDayUsage getTimeOfDayUsage()

Gets how the time of day should be used (start or end)

Returns:: how the time of day should be used

setTimeOfDayUsage

public void setTimeOfDayUsage(NATimeOfDayUsage timeOfDayUsage)

Sets how the time of day should be used (start or end)

Parameters:: timeOfDayUsage - how the time of day should be used