Class RouteTaskInfo
- java.lang.Object
-
- com.esri.arcgisruntime.tasks.networkanalysis.RouteTaskInfo
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
getAccumulateAttributeNames()
Gets the list of network attributes that can be accumulated and returned as part of the route.Map<String,CostAttribute>
getCostAttributes()
Gets list of cost attributes that can be used as a travel mode impedanceTravelMode.setImpedanceAttributeName(String)
to optimize the route.String
getDefaultTravelModeName()
Gets the default travel mode that can be used to customize the route.UnitSystem
getDirectionsDistanceUnits()
Gets the unit system of measurement used when providing distances for turn-by-turn directions.String
getDirectionsLanguage()
Gets the language used when computing directions.DirectionsStyle
getDirectionsStyle()
Gets the style used for providing directions.NetworkDirectionsSupport
getDirectionsSupport()
Gets an enum value which indicates whether the underlying network dataset supports the returning of directions.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.String
getNetworkName()
Gets the name of the underlying transportation network datasetSpatialReference
getOutputSpatialReference()
Gets The spatial reference in which the result geometries are returned.Map<String,RestrictionAttribute>
getRestrictionAttributes()
Gets the list of supported restrictions for constraining the route.RouteShapeType
getRouteShapeType()
Gets the type of route geometry to return in the resultRoute.getRouteGeometry()
Calendar
getStartTime()
Gets the time the route begins.List<String>
getSupportedLanguages()
Gets the list of languages supported for generating turn-by-turn driving directions.List<String>
getSupportedRestrictionUsageParameterValues()
Gets the supported restriction usage parameter values.List<TravelMode>
getTravelModes()
Gets the available travel modes that can be used to customize the route.boolean
isFindBestSequence()
Gets whether this route task can find best sequence.boolean
isPreserveFirstStop()
Indicates if the route task will keep the first stop fixed in the sequence whenisFindBestSequence()
is enabled.boolean
isPreserveLastStop()
Gets if the route task will keep the last stop fixed in the sequence whenisFindBestSequence()
is enabled.boolean
isSupportsRerouting()
Gets the value of service property "Supports Rerouting".
-
-
-
Method Detail
-
getAccumulateAttributeNames
public List<String> 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
public Map<String,CostAttribute> 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
public String 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
public UnitSystem 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
- See Also:
UnitSystem
-
getDirectionsLanguage
public String getDirectionsLanguage()
Gets the language used when computing directions.- Returns:
- the directions language
- Since:
- 100.0.0
-
getDirectionsStyle
public DirectionsStyle 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
public Calendar 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
public String getNetworkName()
Gets the name of the underlying transportation network dataset- Returns:
- the network name
- Since:
- 100.0.0
-
getOutputSpatialReference
public SpatialReference getOutputSpatialReference()
Gets The spatial reference in which the result geometries are returned.- Returns:
- the output spatial reference
- Since:
- 100.0.0
- See Also:
RouteParameters.setOutputSpatialReference(SpatialReference)
-
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
public Map<String,RestrictionAttribute> 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
public RouteShapeType getRouteShapeType()
Gets the type of route geometry to return in the resultRoute.getRouteGeometry()
- Returns:
- the route shape type
- Since:
- 100.0.0
-
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.0.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.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
public List<TravelMode> 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
public NetworkDirectionsSupport 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
- See Also:
NetworkDirectionsSupport
-
-