public class

ServiceAreaParameters

extends NAParameters
java.lang.Object
   ↳ com.esri.core.tasks.na.NAParameters
     ↳ com.esri.core.tasks.na.ServiceAreaParameters

Class Overview

Class holding the parameters of a service area to be solved on the server.

In this class, you can define:

  • a set of facilities to find a service area around
  • a set of point barriers to avoid when solving
  • a set of polyline barriers to avoid when solving
  • a set of polygon barriers to avoid when solving
  • a list of attribute parameter values
  • if the facilities should be returned
  • if the point barriers should be returned
  • if the polyline barriers should be returned
  • if the polygon barriers should be returned
  • the spatial reference of the returned geometry
  • the default breaks for the service area
  • how the service area lines should be output
  • how the service area polygons should be output
  • a list of accumulate attribute names
  • the name of the impedance attribute
  • a list of the restriction attribute names
  • how to restrict U turns
  • if a hierarchy should be used
  • if sources should be excluded from polygons
  • if similar polygon ranges should be merged
  • if service area lines should be overlapped
  • if service area polygons should be overlapped
  • if lines should be split at breaks
  • if polygons should be split at breaks
  • if the outer polygon should be trimmed
  • the distance to trim the polygon
  • the unit of the distance to trim the polygon
  • the time of day at which to calculate the service area
  • the travel direction of the facilities (to/from)
  • a precision value for the output geometry
  • a unit for the output geometry precision
  • if z values should be returned
  • Summary

    [Expand]
    Inherited Fields
    From class com.esri.core.tasks.na.NAParameters
    Public Constructors
    ServiceAreaParameters()
    Constructor; to obtain a new ServiceAreaParameters object for a certain service, use getDefaultParameters().
    Public Methods
    Double[] getDefaultBreaks()
    Gets the break levels for the service areas (i.e.
    String[] getExcludeSourcesFromPolygons()
    Gets the list of sources to exclude from polygons.
    NAFeatures getFacilities()
    Gets the facilities to find the service areas of.
    Boolean getMergeSimilarPolygonRanges()
    Gets whether or not similar polygon ranges are to be merged.
    NAOutputPolygon getOutputPolygons()
    Gets the type of OutputPolygons (none, simplified, detailed, default).
    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.
    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 isReturnFacilities()
    Gets whether or not facilities should be returned.
    void setDefaultBreaks(Double[] defaultBreaks)
    Sets the break levels for the service areas (i.e.
    void setExcludeSourcesFromPolygons(String[] excludeSourcesFromPolygons)
    Sets the list of sources to exclude from polygons.
    void setFacilities(NAFeatures facilities)
    Sets the facilities to find the service areas of.
    void setMergeSimilarPolygonRanges(Boolean mergeSimilarPolygonRanges)
    Sets whether or not to merge similar polygon ranges.
    void setOutputPolygons(NAOutputPolygon outputPolygons)
    Sets the type of OutputPolygons (none, simplified, detailed, default).
    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 setReturnFacilities(boolean returnFacilities)
    Sets whether or not facilities should be returned.
    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.
    [Expand]
    Inherited Methods
    From class com.esri.core.tasks.na.NAParameters
    From class java.lang.Object

    Public Constructors

    public ServiceAreaParameters ()

    Constructor; to obtain a new ServiceAreaParameters object for a certain service, use getDefaultParameters().

    Public Methods

    public Double[] getDefaultBreaks ()

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

    Returns
    Double[] the break levels for the service areas

    public String[] getExcludeSourcesFromPolygons ()

    Gets the list of sources to exclude from polygons.

    Returns
    String[] the list of sources to exclude from polygons

    public NAFeatures getFacilities ()

    Gets the facilities to find the service areas of.

    Returns
    NAFeatures facilities the facilities to find the service areas of

    public Boolean getMergeSimilarPolygonRanges ()

    Gets whether or not similar polygon ranges are to be merged.

    Returns
    Boolean whether or not similar polygon ranges are to be merged

    public NAOutputPolygon getOutputPolygons ()

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

    Returns
    NAOutputPolygon the type of OutputPolygons

    public Boolean getOverlapLines ()

    Gets whether or not the lines should overlap from multiple facilities.

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

    public Boolean getOverlapPolygons ()

    Gets whether or not the polygons for all facilities should overlap.

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

    public Boolean getSplitLinesAtBreaks ()

    Gets whether or not lines should be split at breaks.

    Returns
    Boolean whether or not lines should be split at breaks

    public Boolean getSplitPolygonsAtBreaks ()

    Gets whether or not polygons should be split at breaks.

    Returns
    Boolean whether or not polygons should be split at breaks

    public Long getTimeOfDay ()

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

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

    public NATravelDirection getTravelDirection ()

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

    Returns
    NATravelDirection the travel direction for the service area computation

    public Boolean getTrimOuterPolygon ()

    Gets whether or not to trim the outermost polygon.

    Returns
    Boolean whether or not to trim the outermost polygon

    public Double getTrimPolygonDistance ()

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

    Returns
    Double the distance to trim the outermost polygon

    public Unit.EsriUnit getTrimPolygonDistanceUnits ()

    Gets the units of the trim distance.

    Returns
    Unit.EsriUnit the units of the trim distance

    public boolean isReturnFacilities ()

    Gets whether or not facilities should be returned.

    Returns
    boolean whether or not facilities should be returned

    public void setDefaultBreaks (Double[] defaultBreaks)

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

    Parameters
    defaultBreaks Double: the break levels for the service areas

    public void setExcludeSourcesFromPolygons (String[] excludeSourcesFromPolygons)

    Sets the list of sources to exclude from polygons.

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

    public void setFacilities (NAFeatures facilities)

    Sets the facilities to find the service areas of.

    Parameters
    facilities NAFeatures: the facilities to find the service areas of

    public void setMergeSimilarPolygonRanges (Boolean mergeSimilarPolygonRanges)

    Sets whether or not to merge similar polygon ranges.

    Parameters
    mergeSimilarPolygonRanges Boolean: true to merge similar polygon ranges

    public void setOutputPolygons (NAOutputPolygon outputPolygons)

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

    Parameters
    outputPolygons NAOutputPolygon: the type of OutputPolygons

    public void setOverlapLines (Boolean overlapLines)

    Sets whether or not the lines should overlap from multiple facilities.

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

    public void setOverlapPolygons (Boolean overlapPolygons)

    Sets whether or not the polygons for all facilities should overlap.

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

    public void setReturnFacilities (boolean returnFacilities)

    Sets whether or not facilities should be returned.

    Parameters
    returnFacilities boolean: true if facilities should be returned

    public void setSplitLinesAtBreaks (Boolean splitLinesAtBreaks)

    Sets whether or not lines should be split at breaks.

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

    public void setSplitPolygonsAtBreaks (Boolean splitPolygonsAtBreaks)

    Sets whether or not polygons should be split at breaks.

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

    public void setTimeOfDay (Long timeOfDay)

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

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

    public void setTravelDirection (NATravelDirection travelDirection)

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

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

    public void setTrimOuterPolygon (Boolean trimOuterPolygon)

    Sets whether or not to trim the outermost polygon.

    Parameters
    trimOuterPolygon Boolean: true to trim the outermost polygon

    public void setTrimPolygonDistance (Double trimPolygonDistance)

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

    Parameters
    trimPolygonDistance Double: the distance to trim the outermost polygon

    public void setTrimPolygonDistanceUnits (Unit.EsriUnit trimPolygonDistanceUnits)

    Sets the units of the trim distance.

    Parameters
    trimPolygonDistanceUnits Unit.EsriUnit: the units of the trim distance