Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.networkanalysis

Class ServiceAreaTaskInfo

java.lang.Object
com.esri.arcgisruntime.tasks.networkanalysis.ServiceAreaTaskInfo
public final class ServiceAreaTaskInfo extends Object
Represents metadata about the network analyst service used by ServiceAreaTask.

ServiceAreaTaskInfo is an immutable object and initialized when the ServiceAreaTask is loaded. Changing ServiceAreaParameters does not affect this.

Since:
100.1.0

  • Method Details

    • getNetworkName

      public String getNetworkName()
      Gets the name of the underlying transportation network dataset.
      Returns:
      the network name
      Since:
      100.1.0

    • getCostAttributes

      public Map<String,CostAttribute> getCostAttributes()
      Gets a map of cost attributes that can be used as a travel mode impedance TravelMode.setImpedanceAttributeName(String) to optimize the service area result. The key in the Map represents the name of the cost attribute.
      Returns:
      an unmodifiable map of the cost attributes
      Since:
      100.1.0

    • getRestrictionAttributes

      public Map<String,RestrictionAttribute> getRestrictionAttributes()
      Gets the map of supported restrictions for constraining the service area result. The key in the Map represents the name of the restriction attribute.
      Returns:
      an unmodifiable map of the restriction attributes
      Since:
      100.1.0

    • getSupportedRestrictionUsageParameterValues

      public List<String> getSupportedRestrictionUsageParameterValues()
      Gets the supported restriction usage parameter values.
      Returns:
      an unmodifiable list of the supported restriction usage parameter values
      Since:
      100.1.0

    • getAccumulateAttributeNames

      public List<String> getAccumulateAttributeNames()
      Gets the list of network attributes that can be accumulated and returned as part of the service area result.

      For example, accumulateAttributeNames = {"Miles", "Kilometers"} indicates that the total cost of the service area result should also be calculated in miles and kilometers. All supported attributes can be obtained from getCostAttributes().

      Returns:
      an unmodifiable list of the accumulate attribute names
      Since:
      100.1.0
      See Also:

    • getTravelModes

      public List<TravelMode> getTravelModes()
      Gets the available travel modes that can be used to customize the service area result.
      Returns:
      an unmodifiable list of the travel modes
      Since:
      100.1.0

    • getDefaultTravelModeName

      public String getDefaultTravelModeName()
      Gets the default travel mode that can be used to customize the service area result.
      Returns:
      the default travel mode name
      Since:
      100.1.0

    • getStartTime

      public Calendar getStartTime()
      Gets the default time the service area result begins. If not specified, defaults to the time the task is executed.
      Returns:
      the start time or null if no default start time is specified
      Since:
      100.1.0
      See Also:

    • getOutputSpatialReference

      public SpatialReference getOutputSpatialReference()
      Gets the output spatial reference in which the result geometries are returned.
      Returns:
      the output spatial reference
      Since:
      100.1.0
      See Also:

    • getDefaultImpedanceCutoffs

      public List<Double> getDefaultImpedanceCutoffs()
      Gets the default impedance cutoffs.

      Cutoffs specify the quantity of the impedance to apply. They constrain the extent of the service area to be calculated. For example, if you apply breaks of 5, 10, and 15 when the impedance is set to Time, the service area will include those streets that can be reached within 5, 10, and 15 minutes. The units for impedance cutoffs is based on the value of the TravelMode.getImpedanceAttributeName(). For example, if TravelMode.getImpedanceAttributeName() is TravelTime, the defaultImpedanceCutoffs are specified in minutes.

      Returns:
      an unmodifiable list of default impedance cutoffs
      Since:
      100.1.0
      See Also:

    • getTravelDirection

      public TravelDirection getTravelDirection()
      Gets the travel direction.
      Returns:
      the travel direction
      Since:
      100.1.0
      See Also:

    • getPolygonBufferDistance

      public double getPolygonBufferDistance()
      Gets the service area polygon buffer distance in meters.

      The polygon buffer refers to the distance from the road the service area polygon should extend when no other reachable roads are nearby, similar to a line buffer size. This is useful if the network is very sparse and you don't want the service area to cover large areas where there are no features.

      Returns:
      the polygon buffer distance in meters
      Since:
      100.1.0
      See Also:

    • getPolygonDetail

      public ServiceAreaPolygonDetail getPolygonDetail()
      Gets the level of detail of the output polygons.

      If your analysis covers an urban area with a grid-like street network, the difference between generalized and standard polygons will be minimal. However, for mountain and rural roads, the standard and detailed polygons may present significantly more accurate results than generalized polygons.

      Returns:
      the level of detail of the output polygons
      Since:
      100.1.0
      See Also:

    • getGeometryAtOverlap

      public ServiceAreaOverlapGeometry getGeometryAtOverlap()
      Gets the geometry overlap behavior.

      Specifies the behavior of service area output from multiple facilities in relation to one another.

      Returns:
      the behavior for overlapping geometry
      Since:
      100.1.0
      See Also:

    • getMaxLocatingDistance

      public double getMaxLocatingDistance()
      Gets the maximum locating distance, which is the furthest distance in meters that Network Analyst searches when locating or relocating a point onto the network.

      The search looks for suitable edges or junctions and snaps the point to the nearest one. If a suitable location isn't found within the maximum locating distance, the object is marked as unlocated.

      Returns:
      the maximum locating distance
      Since:
      100.6.0

    • getGeometryAtCutoff

      public ServiceAreaPolygonCutoffGeometry getGeometryAtCutoff()
      Gets the behavior on geometry at cutoff.

      Specifies the behavior of service area output for a single facility when multiple cutoff values are specified. This parameter does not apply to line output.

      Returns:
      the behavior for geometry at cutoff
      Since:
      100.1.0
      See Also:

    • isReturnPolylines

      public boolean isReturnPolylines()
      Indicates if polylines will be generated in the result.

      Service area output will contain line features representing the roads reachable before the cutoffs are exceeded.

      Returns:
      true for returning polylines after solving, false otherwise
      Since:
      100.1.0
      See Also:

    • isReturnPolygons

      public boolean isReturnPolygons()
      Indicates if polygons will be generated in the result.

      Service areas output will contain polygon features encompassing reachable area(s).

      Returns:
      true for returning polygons after solving, false otherwise
      Since:
      100.1.0
      See Also: