Package com.esri.arcgisruntime.tasks.networkanalysis

Class ClosestFacilityTaskInfo

  • public final class ClosestFacilityTaskInfo
extends java.lang.Object
    Describes the transportation network that a closest facility is bound to. Represents metadata about the network analyst service used by ClosestFacilityTask.

    ClosestFacilityTaskInfo info is an immutable object and initialized when the ClosestFacilityTask is loaded. Changing closest facility parameters 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 closest facility route. 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 closest facility route. 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

      • getTravelModes

        public java.util.List<TravelMode> getTravelModes()
        Gets the available travel modes that can be used to customize the closest facility route.
        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 closest facility route.
        Returns:
        the default travel mode name
        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 closest facility route.

        For example, accumulateAttributeNames = {"Miles", "Kilometers"} indicates that the total cost of the closest facility route 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:
        ClosestFacilityParameters.getAccumulateAttributeNames()

      • getStartTime

        public java.util.Calendar getStartTime()
        Gets the default time the closest facility route begins. If not specified, defaults to the time the task is executed.
        Returns:
        the start time, it can be null
        Since:
        100.1.0
        See Also:
        ClosestFacilityParameters.setStartTime(Calendar)

      • getSupportedLanguages

        public java.util.List<java.lang.String> getSupportedLanguages()
        Gets the list of languages supported for generating turn-by-turn driving directions.
        Returns:
        an unmodifiable list of the supported languages
        Since:
        100.1.0

      • 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

      • getDirectionsSupport

        public NetworkDirectionsSupport getDirectionsSupport()
        Gets whether the underlying network dataset supports the returning of directions. For services prior to ArcGIS 10.8, this value will be NetworkDirectionsSupport.UNKNOWN.
        Returns:
        whether the underlying network dataset supports the returning of directions
        Since:
        100.7.0