RoutingTaskParameters (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 RoutingTaskParameters

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

public class RoutingTaskParameters
extends NATaskParameters
extends NATaskParameters

Constructor Summary
`RoutingTaskParameters()`

Method Summary
`String[]`	`getAccumulateAttributeNames()` Returns the list of accumulate attribute names
`AttributeParameterValue[]`	`getAttributeParameterValues()` Returns the list of attribute parameter values
`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
`Boolean`	`getFindBestSequence()` Gets whether or not to find the best sequence of stops
`Boolean`	`getIgnoreInvalidLocations()` Gets whether or not invalid locations should be ignored
`String`	`getImpedanceAttributeName()` Returns the name of the impedance attribute to use
`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
`Boolean`	`getPreserveFirstStop()` Gets whether or not to preserve the first stop
`Boolean`	`getPreserveLastStop()` Gets whether or not to preserve the last stop
`String[]`	`getRestrictionAttributeNames()` Returns the list of restriction attribute names
`UTurnRestriction`	`getRestrictUTurns()` Returns the type of U turn restriction to use
`Long`	`getStartTime()` Returns the time to start the routing
`NAFeatures`	`getStops()` Returns the stops to route between
`Boolean`	`getUseHierarchy()` Gets whether or not to use hierarchy
`Boolean`	`getUseTimeWindows()` Gets whether or not to use time windows
`boolean`	`isReturnDirections()` Gets whether or not to return directions
`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`	`isReturnRoutes()` Gets whether or not to return routes
`boolean`	`isReturnStops()` Gets whether or not to return stops
`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`	`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`	`setFindBestSequence(Boolean findBestSequence)` Sets whether or not to find the best sequence of stops
`void`	`setIgnoreInvalidLocations(Boolean ignoreInvalidLocations)` Gets whether or not invalid locations should be ignored
`void`	`setImpedanceAttributeName(String impedanceAttributeName)` Sets the name of the impedance attribute to use
`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`	`setPreserveFirstStop(Boolean preserveFirstStop)` Sets whether or not to preserve the first stop
`void`	`setPreserveLastStop(Boolean preserveLastStop)` Sets whether or not to preserve the last stop
`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`	`setReturnDirections(boolean returnDirections)` Sets whether or not to return directions
`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`	`setReturnRoutes(boolean returnRoutes)` Sets whether or not to return routes
`void`	`setReturnStops(boolean returnStops)` Sets whether or not to return stops
`void`	`setReturnZ(boolean returnZ)` Sets whether or not to return z values
`void`	`setStartTime(Long startTime)` Sets the time to start the routing
`void`	`setStops(NAFeatures stops)` Sets the stops to route between
`void`	`setUseHierarchy(Boolean useHierarchy)` Sets whether or not to use hierarchy
`void`	`setUseTimeWindows(Boolean useTimeWindows)` Sets whether or not to use time windows

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

Constructor Detail

RoutingTaskParameters

public RoutingTaskParameters()

Method Detail

getStops

public NAFeatures getStops()

Returns the stops to route between

Returns:: the stops to route between

setStops

public void setStops(NAFeatures stops)

Sets the stops to route between

Parameters:: stops - the stops to route between

isReturnDirections

public boolean isReturnDirections()

Gets whether or not to return directions

Returns:: true if directions should be returned

setReturnDirections

public void setReturnDirections(boolean returnDirections)

Sets whether or not to return directions

Parameters:: returnDirections - true if directions should be returned

isReturnRoutes

public boolean isReturnRoutes()

Gets whether or not to return routes

Returns:: true if routes should be returned

setReturnRoutes

public void setReturnRoutes(boolean returnRoutes)

Sets whether or not to return routes

Parameters:: returnRoutes - true if routes should be returned

isReturnStops

public boolean isReturnStops()

Gets whether or not to return stops

Returns:: true if stops should be returned

setReturnStops

public void setReturnStops(boolean returnStops)

Sets whether or not to return stops

Parameters:: returnStops - true if stops should be returned

getIgnoreInvalidLocations

public Boolean getIgnoreInvalidLocations()

Gets whether or not invalid locations should be ignored

Returns:: true if invalid locations should be ignored

setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(Boolean ignoreInvalidLocations)

Gets whether or not invalid locations should be ignored

Parameters:: ignoreInvalidLocations - true if invalid locations should be ignored

getFindBestSequence

public Boolean getFindBestSequence()

Gets whether or not to find the best sequence of stops

Returns:: true to find the best sequence of stops

setFindBestSequence

public void setFindBestSequence(Boolean findBestSequence)

Sets whether or not to find the best sequence of stops

Parameters:: findBestSequence - true to find the best sequence of stops

getPreserveFirstStop

public Boolean getPreserveFirstStop()

Gets whether or not to preserve the first stop

Returns:: true to preserve the first stop

setPreserveFirstStop

public void setPreserveFirstStop(Boolean preserveFirstStop)

Sets whether or not to preserve the first stop

Parameters:: preserveFirstStop - true to preserve the first stop

getPreserveLastStop

public Boolean getPreserveLastStop()

Gets whether or not to preserve the last stop

Returns:: true to preserve the last stop

setPreserveLastStop

public void setPreserveLastStop(Boolean preserveLastStop)

Sets whether or not to preserve the last stop

Parameters:: preserveLastStop - true to preserve the last stop

getUseTimeWindows

public Boolean getUseTimeWindows()

Gets whether or not to use time windows

Returns:: true to use time windows

setUseTimeWindows

public void setUseTimeWindows(Boolean useTimeWindows)

Sets whether or not to use time windows

Parameters:: useTimeWindows - true to use time windows

getStartTime

public Long getStartTime()

Returns the time to start the routing

Returns:: the time to start the routing

setStartTime

public void setStartTime(Long startTime)

Sets the time to start the routing

Parameters:: startTime - the time to start the routing

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