Package com.esri.arcgisruntime.tasks.networkanalysis

Class ClosestFacilityRoute

java.lang.Object

com.esri.arcgisruntime.tasks.networkanalysis.ClosestFacilityRoute

public final class ClosestFacilityRoute
extends java.lang.Object

Represents an independent closest facility route within a ClosestFacilityResult.

Since:

100.1.0

Method Summary

Modifier and Type	Method	Description
CurbApproach	getArrivalCurbApproach()	Gets the arrival curb approach.
double	getCost(java.lang.String attributeName)	Gets the cost for the given attribute.
CurbApproach	getDepartureCurbApproach()	Gets the departure curb approach.
java.util.List<DirectionManeuver>	getDirectionManeuvers()	Gets the turn-by-turn driving directions along this route.
java.util.Calendar	getEndTime()	Gets the time when the route ends (arriving at the last facility or incident).
double	getEndTimeShift()	Gets the shift for end time.
Polyline	getRouteGeometry()	Gets the route's geometry.
java.util.Calendar	getStartTime()	Gets the time when the route begins (departing from the first incident or facility).
double	getStartTimeShift()	Gets the shift for start time.
double	getTotalLength()	Gets the total length of the ClosestFacilityRoute in meters.
double	getTotalTime()	Gets the overall time (in minutes) taken by the route from start to end.
double	getTravelTime()	Gets the time (in minutes) to travel along the route.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRouteGeometry

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

public java.util.Calendar 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()

Gets the shift for start time.

Returns:

a value of time zone shift in minutes

Since:

100.1.0

See Also:

getStartTime()

getEndTime

public java.util.Calendar 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()

Gets the shift for end time.

Returns:

a value of time zone shift in minutes

Since:

100.1.0

See Also:

getEndTime()

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

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

Incident.getCurbApproach(), Facility.getCurbApproach()

getArrivalCurbApproach

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

Incident.getCurbApproach(), Facility.getCurbApproach()

getDirectionManeuvers

public java.util.List<DirectionManeuver> getDirectionManeuvers()

Gets the turn-by-turn driving directions along this route. Only available if ClosestFacilityParameters.setReturnDirections(boolean) is set.

Returns:

an unmodifiable list of the direction maneuvers

Since:

100.1.0

getCost

public double getCost(java.lang.String attributeName)

Gets the cost for the given attribute.

Parameters:

attributeName - attribute name

Returns:

the cost

Throws:

java.lang.IllegalArgumentException - if attributeName is null or empty

ArcGISRuntimeException - if attributeName is invalid

Since:

100.1.0