Package com.esri.arcgisruntime.tasks.networkanalysis

Class ServiceAreaTaskInfo

  • public final class ServiceAreaTaskInfo
extends java.lang.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 Detail

      • getNetworkName

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

      • getCostAttributes

        public java.util.Map<java.lang.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 java.util.Map<java.lang.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 java.util.List<java.lang.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 java.util.List<java.lang.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:
        ServiceAreaParameters.getAccumulateAttributeNames()

      • getTravelModes

        public java.util.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 java.lang.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 java.util.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:
        ServiceAreaParameters.setStartTime(Calendar)

      • getDefaultImpedanceCutoffs

        public java.util.List<java.lang.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:
        ServiceAreaParameters.getDefaultImpedanceCutoffs(), ServiceAreaFacility.getImpedanceCutoffs()

      • 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:
        ServiceAreaParameters.setPolygonBufferDistance(double)

      • 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:
        ServiceAreaParameters.setPolygonDetail(ServiceAreaPolygonDetail)

      • 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

      • 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:
        ServiceAreaParameters.setReturnPolylines(boolean)

      • 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:
        ServiceAreaParameters.setReturnPolygons(boolean)