Module com.esri.arcgisruntime
Class RouteTaskInfo
java.lang.Object
com.esri.arcgisruntime.tasks.networkanalysis.RouteTaskInfo
Represents metadata about the network analyst service or dataset used by
RouteTask
RouteTaskInfo info is an immutable object and initialized only once when task is loaded. Changing route parameters does not affect this.
- Since:
- 100.0.0
-
Method Summary
Modifier and TypeMethodDescriptionGets the list of network attributes that can be accumulated and returned as part of the route.Gets list of cost attributes that can be used as a travel mode impedanceTravelMode.setImpedanceAttributeName(String)
to optimize the route.Gets the default travel mode that can be used to customize the route.Gets the unit system of measurement used when providing distances for turn-by-turn directions.Gets the language used when computing directions.Gets the style used for providing directions.Gets an enum value which indicates whether the underlying network dataset supports the returning of directions.double
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.Gets the name of the underlying transportation network datasetGets The spatial reference in which the result geometries are returned.Gets the list of supported restrictions for constraining the route.Gets the type of route geometry to return in the resultRoute.getRouteGeometry()
Gets the time the route begins.Gets the list of languages supported for generating turn-by-turn driving directions.Gets the supported restriction usage parameter values.Gets the available travel modes that can be used to customize the route.boolean
Gets whether this route task can find best sequence.boolean
Indicates if the route task will keep the first stop fixed in the sequence whenisFindBestSequence()
is enabled.boolean
Gets if the route task will keep the last stop fixed in the sequence whenisFindBestSequence()
is enabled.boolean
Gets the value of service property "Supports Rerouting".
-
Method Details
-
getAccumulateAttributeNames
Gets the list of network attributes that can be accumulated and returned as part of the route.- Returns:
- an unmodifiable list of the accumulate attribute names
- Since:
- 100.0.0
-
getCostAttributes
Gets list of cost attributes that can be used as a travel mode impedanceTravelMode.setImpedanceAttributeName(String)
to optimize the route. The key in the Map represents the name of the cost attribute.- Returns:
- an unmodifiable map of the cost attributes
- Since:
- 100.0.0
-
isFindBestSequence
public boolean isFindBestSequence()Gets whether this route task can find best sequence.- Returns:
- whether the route task can find best sequence
- Since:
- 100.0.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
-
getDefaultTravelModeName
Gets the default travel mode that can be used to customize the route.- Returns:
- the default travel mode name
- Since:
- 100.0.0
-
getDirectionsDistanceUnits
Gets the unit system of measurement used when providing distances for turn-by-turn directions.- Returns:
- the unit system of measurement
- Since:
- 100.0.0
-
getDirectionsLanguage
Gets the language used when computing directions.- Returns:
- the directions language
- Since:
- 100.0.0
-
getDirectionsStyle
Gets the style used for providing directions. The directions setting to generate directions designed for different kinds of applications.- Returns:
- the directions style
- Since:
- 100.0.0
-
getStartTime
Gets the time the route begins. If not specified, defaults to the time the task is executed.- Returns:
- the start time. It can be null.
- Since:
- 100.0.0
-
getNetworkName
Gets the name of the underlying transportation network dataset- Returns:
- the network name
- Since:
- 100.0.0
-
getOutputSpatialReference
Gets The spatial reference in which the result geometries are returned.- Returns:
- the output spatial reference
- Since:
- 100.0.0
- See Also:
-
isPreserveFirstStop
public boolean isPreserveFirstStop()Indicates if the route task will keep the first stop fixed in the sequence whenisFindBestSequence()
is enabled.- Returns:
- whether the route task can preserve first stop
- Since:
- 100.0.0
-
isPreserveLastStop
public boolean isPreserveLastStop()Gets if the route task will keep the last stop fixed in the sequence whenisFindBestSequence()
is enabled.- Returns:
- whether the route task can preserve last stop
- Since:
- 100.0.0
-
getRestrictionAttributes
Gets the list of supported restrictions for constraining the route. The key in the Map represents the name of the restriction attribute.- Returns:
- an unmodifiable map of the restriction attributes
- Since:
- 100.0.0
-
getRouteShapeType
Gets the type of route geometry to return in the resultRoute.getRouteGeometry()
- Returns:
- the route shape type
- Since:
- 100.0.0
-
getSupportedLanguages
Gets the list of languages supported for generating turn-by-turn driving directions.- Returns:
- an unmodifiable list of the supported languages
- Since:
- 100.0.0
-
getSupportedRestrictionUsageParameterValues
Gets the supported restriction usage parameter values.- Returns:
- an unmodifiable list of the supported restriction usage parameter values
- Since:
- 100.0.0
-
isSupportsRerouting
public boolean isSupportsRerouting()Gets the value of service property "Supports Rerouting".If property doesn't exist on service value will be
false
. For local data value will betrue
.- Returns:
- the value of service property "Supports Rerouting"
- Since:
- 100.6.0
-
getTravelModes
Gets the available travel modes that can be used to customize the route.- Returns:
- an unmodifiable list of the travel modes
- Since:
- 100.0.0
-
getDirectionsSupport
Gets an enum value which indicates whether the underlying network dataset supports the returning of directions. For services prior to ArcGIS 10.8, this value will beNetworkDirectionsSupport.UNKNOWN
.- Returns:
- whether the underlying network dataset supports the returning of directions
- Since:
- 100.7.0
-