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

Class ClosestFacilityTaskInfo

java.lang.Object
com.esri.arcgisruntime.tasks.networkanalysis.ClosestFacilityTaskInfo
public final class ClosestFacilityTaskInfo extends 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 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 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 Map<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 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

    • getTravelModes

      public 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 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 List<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:

    • getStartTime

      public 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:

    • getStartTimeUsage

      public StartTimeUsage getStartTimeUsage()
      Gets the default start time usage type.
      Returns:
      the start time usage type
      Since:
      100.1.0
      See Also:

    • getDefaultTargetFacilityCount

      public int getDefaultTargetFacilityCount()
      Gets the default target facility count.
      Returns:
      default count of target facility
      Since:
      100.1.0
      See Also:

    • getDefaultImpedanceCutoff

      public double getDefaultImpedanceCutoff()
      Gets the default impedance cutoff is a value for the impedance beyond which facilities should not be found.

      For instance, while finding the closest hospitals from the site of an accident, a cutoff value of 15 minutes would mean that the closest facility task would search for the closest hospital within 15 minutes from the incident. If the closest hospital is 17 minutes away, no routes will be returned in the output routes. A cutoff value is especially useful when searching for multiple facilities or incidents. The units for impedance cutoff is based on the value of the TravelMode.getImpedanceAttributeName(). For example, if TravelMode.getImpedanceAttributeName() is TravelTime, the defaultImpedanceCutoff is specified in minutes.

      Returns:
      default impedance cutoff
      Since:
      100.1.0
      See Also:

    • getTravelDirection

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

    • getRouteShapeType

      public RouteShapeType getRouteShapeType()
      Gets the default type of closet facility route geometry to return in the result ClosestFacilityRoute.getRouteGeometry().
      Returns:
      the route shape type
      Since:
      100.1.0
      See Also:

    • getOutputSpatialReference

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

    • getSupportedLanguages

      public List<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

    • getDirectionsDistanceUnits

      public UnitSystem getDirectionsDistanceUnits()
      Gets the default unit system of measurement used when providing distances for turn-by-turn directions.
      Returns:
      the unit system of measurement
      Since:
      100.1.0
      See Also:

    • getDirectionsLanguage

      public String getDirectionsLanguage()
      Gets the default language used when computing directions.
      Returns:
      the directions language
      Since:
      100.1.0
      See Also:

    • getDirectionsStyle

      public DirectionsStyle getDirectionsStyle()
      Gets the default style used for providing directions.
      Returns:
      the directions style
      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

    • 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