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

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

public class ServiceAreaTaskParameters
extends NATaskParameters
extends NATaskParameters

Constructor Summary
`ServiceAreaTaskParameters()`

Method Summary
`String[]`	`getAccumulateAttributeNames()` Returns the list of accumulate attribute names
`AttributeParameterValue[]`	`getAttributeParameterValues()` Returns the list of attribute parameter values
`Double[]`	`getDefaultBreaks()` Gets the break levels for the service area (i.e. 1, 3, and 5 minute break levels)
`String[]`	`getExcludeSourcesFromPolygons()` Gets the list of sources to exclude from polygons
`NAFeatures`	`getFacilities()` Gets the facilities to find service area of
`String`	`getImpedanceAttributeName()` Returns the name of the impedance attribute to use
`Boolean`	`getMergeSimilarPolygonRanges()` Gets whether or not to merge similar polygon ranges
`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
`NAOutputPolygon`	`getOutputPolygons()` Gets the type of OutputPolygons (none, simplified, detailed, default)
`SpatialReference`	`getOutSpatialReference()` Returns the spatial reference of the output geometry
`Boolean`	`getOverlapLines()` Gets whether or not the lines should overlap from multiple facilities
`Boolean`	`getOverlapPolygons()` Gets whether or not the polygons for all facilities should overlap
`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
`Boolean`	`getSplitLinesAtBreaks()` Gets whether or not lines should be split at breaks
`Boolean`	`getSplitPolygonsAtBreaks()` Gets whether or not polygons should be split at breaks
`Long`	`getTimeOfDay()` Gets what time of day the service area should be computed at
`NATravelDirection`	`getTravelDirection()` Gets the travel direction for the service area computation (to or from facility)
`Boolean`	`getTrimOuterPolygon()` Gets whether or not to trim the outermost polygon
`Double`	`getTrimPolygonDistance()` Gets the distance to trim the outermost polygon, if trimming is set to true
`Unit.EsriUnit`	`getTrimPolygonDistanceUnits()` Gets the units of the trim distance
`Boolean`	`getUseHierarchy()` Gets whether or not to use hierarchy
`boolean`	`isReturnFacilities()` Gets whether or not facilities should be returned
`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`	`setDefaultBreaks(Double[] defaultBreaks)` Sets the break levels for the service area (i.e. 1, 3, and 5 minute break levels)
`void`	`setExcludeSourcesFromPolygons(String[] excludeSourcesFromPolygons)` Sets the list of sources to exclude from polygons
`void`	`setFacilities(NAFeatures facilities)` Sets the facilities to find service area of
`void`	`setImpedanceAttributeName(String impedanceAttributeName)` Sets the name of the impedance attribute to use
`void`	`setMergeSimilarPolygonRanges(Boolean mergeSimilarPolygonRanges)` Sets ets whether or not to merge similar polygon ranges
`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`	`setOutputPolygons(NAOutputPolygon outputPolygons)` Sets the type of OutputPolygons (none, simplified, detailed, default)
`void`	`setOutSpatialReference(SpatialReference outSpatialReference)` Sets the spatial reference of the output geometry
`void`	`setOverlapLines(Boolean overlapLines)` Sets whether or not the lines should overlap from multiple facilities
`void`	`setOverlapPolygons(Boolean overlapPolygons)` Sets whether or not the polygons for all facilities should overlap
`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`	`setReturnFacilities(boolean returnFacilities)` Sets whether or not facilities should be returned
`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`	`setSplitLinesAtBreaks(Boolean splitLinesAtBreaks)` Sets whether or not lines should be split at breaks
`void`	`setSplitPolygonsAtBreaks(Boolean splitPolygonsAtBreaks)` Sets whether or not polygons should be split at breaks
`void`	`setTimeOfDay(Long timeOfDay)` Sets what time of day the service area should be computed at
`void`	`setTravelDirection(NATravelDirection travelDirection)` Sets the travel direction for the service area computation (to or from facility)
`void`	`setTrimOuterPolygon(Boolean trimOuterPolygon)` Sets whether or not to trim the outermost polygon
`void`	`setTrimPolygonDistance(Double trimPolygonDistance)` Sets the distance to trim the outermost polygon, if trimming is set to true
`void`	`setTrimPolygonDistanceUnits(Unit.EsriUnit trimPolygonDistanceUnits)` Sets the units of the trim distance
`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

ServiceAreaTaskParameters

public ServiceAreaTaskParameters()

Method Detail

getFacilities

public NAFeatures getFacilities()

Gets the facilities to find service area of

Returns:: facilities the facilities to find service area of

setFacilities

public void setFacilities(NAFeatures facilities)

Sets the facilities to find service area of

Parameters:: facilities - the facilities to find service area of

getDefaultBreaks

public Double[] getDefaultBreaks()

Gets the break levels for the service area (i.e. 1, 3, and 5 minute break levels)

Returns:: the break levels for the service area

setDefaultBreaks

public void setDefaultBreaks(Double[] defaultBreaks)

Sets the break levels for the service area (i.e. 1, 3, and 5 minute break levels)

Parameters:: defaultBreaks - the break levels for the service area

getExcludeSourcesFromPolygons

public String[] getExcludeSourcesFromPolygons()

Gets the list of sources to exclude from polygons

Returns:: the list of sources to exclude from polygons

setExcludeSourcesFromPolygons

public void setExcludeSourcesFromPolygons(String[] excludeSourcesFromPolygons)

Sets the list of sources to exclude from polygons

Parameters:: excludeSourcesFromPolygons - the list of sources to exclude from polygons

getMergeSimilarPolygonRanges

public Boolean getMergeSimilarPolygonRanges()

Gets whether or not to merge similar polygon ranges

Returns:: whether or not to merge similar polygon ranges

setMergeSimilarPolygonRanges

public void setMergeSimilarPolygonRanges(Boolean mergeSimilarPolygonRanges)

Sets ets whether or not to merge similar polygon ranges

Parameters:: mergeSimilarPolygonRanges - true to merge similar polygon ranges

getOutputPolygons

public NAOutputPolygon getOutputPolygons()

Gets the type of OutputPolygons (none, simplified, detailed, default)

Returns:: the type of OutputPolygons

setOutputPolygons

public void setOutputPolygons(NAOutputPolygon outputPolygons)

Sets the type of OutputPolygons (none, simplified, detailed, default)

Parameters:: outputPolygons - the type of OutputPolygons

getOverlapLines

public Boolean getOverlapLines()

Gets whether or not the lines should overlap from multiple facilities

Returns:: whether or not the lines should overlap from multiple facilities

setOverlapLines

public void setOverlapLines(Boolean overlapLines)

Sets whether or not the lines should overlap from multiple facilities

Parameters:: overlapLines - true if the lines should overlap from multiple facilities

getOverlapPolygons

public Boolean getOverlapPolygons()

Gets whether or not the polygons for all facilities should overlap

Returns:: whether or not the polygons for all facilities should overlap

setOverlapPolygons

public void setOverlapPolygons(Boolean overlapPolygons)

Sets whether or not the polygons for all facilities should overlap

Parameters:: overlapPolygons - true if the polygons for all facilities should overlap

getSplitLinesAtBreaks

public Boolean getSplitLinesAtBreaks()

Gets whether or not lines should be split at breaks

Returns:: whether or not lines should be split at breaks

setSplitLinesAtBreaks

public void setSplitLinesAtBreaks(Boolean splitLinesAtBreaks)

Sets whether or not lines should be split at breaks

Parameters:: splitLinesAtBreaks - true if lines should be split at breaks

getSplitPolygonsAtBreaks

public Boolean getSplitPolygonsAtBreaks()

Gets whether or not polygons should be split at breaks

Returns:: whether or not polygons should be split at breaks

setSplitPolygonsAtBreaks

public void setSplitPolygonsAtBreaks(Boolean splitPolygonsAtBreaks)

Sets whether or not polygons should be split at breaks

Parameters:: splitPolygonsAtBreaks - true if polygons should be split at breaks

getTrimOuterPolygon

public Boolean getTrimOuterPolygon()

Gets whether or not to trim the outermost polygon

Returns:: whether or not to trim the outermost polygon

setTrimOuterPolygon

public void setTrimOuterPolygon(Boolean trimOuterPolygon)

Sets whether or not to trim the outermost polygon

Parameters:: trimOuterPolygon - true to trim the outermost polygon

getTrimPolygonDistance

public Double getTrimPolygonDistance()

Gets the distance to trim the outermost polygon, if trimming is set to true

Returns:: the distance to trim the outermost polygon

setTrimPolygonDistance

public void setTrimPolygonDistance(Double trimPolygonDistance)

Sets the distance to trim the outermost polygon, if trimming is set to true

Parameters:: trimPolygonDistance - the distance to trim the outermost polygon

getTrimPolygonDistanceUnits

public Unit.EsriUnit getTrimPolygonDistanceUnits()

Gets the units of the trim distance

Returns:: the units of the trim distance

setTrimPolygonDistanceUnits

public void setTrimPolygonDistanceUnits(Unit.EsriUnit trimPolygonDistanceUnits)

Sets the units of the trim distance

Parameters:: trimPolygonDistanceUnits - the units of the trim distance

isReturnFacilities

public boolean isReturnFacilities()

Gets whether or not facilities should be returned

Returns:: whether or not facilities should be returned

setReturnFacilities

public void setReturnFacilities(boolean returnFacilities)

Sets whether or not facilities should be returned

Parameters:: returnFacilities - true if facilities should be returned

getTimeOfDay

public Long getTimeOfDay()

Gets what time of day the service area should be computed at

Returns:: the time of day the service area should be computed at

setTimeOfDay

public void setTimeOfDay(Long timeOfDay)

Sets what time of day the service area should be computed at

Parameters:: timeOfDay - the time of day the service area should be computed at

getTravelDirection

public NATravelDirection getTravelDirection()

Gets the travel direction for the service area computation (to or from facility)

Returns:: the travel direction for the service area computation

setTravelDirection

public void setTravelDirection(NATravelDirection travelDirection)

Sets the travel direction for the service area computation (to or from facility)

Parameters:: travelDirection - the travel direction for the service area computation