Module com.esri.arcgisruntime
Class ClosestFacilityRoute
java.lang.Object
com.esri.arcgisruntime.tasks.networkanalysis.ClosestFacilityRoute
Represents an independent closest facility route within a
ClosestFacilityResult
.- Since:
- 100.1.0
-
Method Summary
Modifier and TypeMethodDescriptionGets the arrival curb approach.double
Gets the cost for the given attribute.Gets the departure curb approach.Gets the turn-by-turn driving directions along this route.Gets the time when the route ends (arriving at the last facility or incident).double
Time zone shift for end time, in minutes.Gets the route's geometry.Gets the time when the route begins (departing from the first incident or facility).double
Time zone shift for start time, in minutes.double
Gets the total length of the ClosestFacilityRoute in meters.double
Gets the overall time (in minutes) taken by the route from start to end.double
Gets the time (in minutes) to travel along the route.
-
Method Details
-
getRouteGeometry
Gets the route's geometry.- Returns:
- the route's geometry
- Since:
- 100.1.0
-
getTravelTime
public double getTravelTime()Gets the time (in minutes) to travel along the route.- Returns:
- the travel time
- Since:
- 100.1.0
-
getTotalTime
public double getTotalTime()Gets the overall time (in minutes) taken by the route from start to end.- Returns:
- the total time
- Since:
- 100.1.0
-
getStartTime
Gets the time when the route begins (departing from the first incident or facility).- Returns:
- the local start time. Returns null if the local start time was not set in
ClosestFacilityParameters.setStartTime(Calendar)
- Since:
- 100.1.0
-
getStartTimeShift
public double getStartTimeShift()Time zone shift for start time, in minutes.- Returns:
- time zone shift for start time, in minutes
- Since:
- 100.1.0
- See Also:
-
getEndTime
Gets the time when the route ends (arriving at the last facility or incident).- Returns:
- the local end time. Returns null if the local start time was not set in set in
ClosestFacilityParameters
- Since:
- 100.1.0
-
getEndTimeShift
public double getEndTimeShift()Time zone shift for end time, in minutes.- Returns:
- time zone shift for end time, in minutes
- Since:
- 100.1.0
- See Also:
-
getTotalLength
public double getTotalLength()Gets the total length of the ClosestFacilityRoute in meters.- Returns:
- the total route length in meters
- Since:
- 100.1.0
-
getDepartureCurbApproach
Gets the departure curb approach. Direction from which a vehicle may depart from the incident or facility.- Returns:
- the departure curb approach
- Since:
- 100.1.0
- See Also:
-
getArrivalCurbApproach
Gets the arrival curb approach. Direction from which a vehicle may arrive at the incident or facility.- Returns:
- the arrival curb approach
- Since:
- 100.1.0
- See Also:
-
getDirectionManeuvers
Gets the turn-by-turn driving directions along this route. Only available ifClosestFacilityParameters.setReturnDirections(boolean)
is set.- Returns:
- an unmodifiable list of the direction maneuvers
- Since:
- 100.1.0
-
getCost
Gets the cost for the given attribute.- Parameters:
attributeName
- attribute name- Returns:
- the cost
- Throws:
IllegalArgumentException
- if attributeName is null or emptyArcGISRuntimeException
- if attributeName is invalid- Since:
- 100.1.0
-