Route Output Fields—Python in ArcGIS Notebook Server

On successful execution the tool returns the best routes between the stops, and the status indicating whether the analysis was successful, using the output parameters described below.

Output Routes

Upon successful execution of FindRoutes, the tool returns the best routes between the stops, and the status indicating whether the analysis was successful, using the output parameters described below.

The following table lists the fields returned for each route:


Field	Description	Data type
Name	The name of the route is based on the RouteName field of the associated stops. If the input RouteName field is null, the name is derived from the Name field of the first and last stop.	String
StopCount	The number of stops assigned to the route.	Long
Total_Minutes	The cumulative travel time in minutes of the route between the stops.	Double
Total_Miles	The cumulative travel distance, in miles, of the route between the stops.	Double
FirstStopOID	The ObjectID value of the first stop on the route. This field is often used to join information from input stops to routes.	Long
LastStopOID	The ObjectID value of the last stop on the route. This field is often used to join information from input stops to routes.	Long
Total_Kilometers	The cumulative travel distance, in kilometers, of the route between the stops.	Double

Output Route Edges

Use this parameter to access the individual road segments along which the routes travel.

The following table lists the fields returned for each route edge:


Field	Description	Data type
SourceName	The name of the edge source feature class from which the line was generated.	String
SourceOID	The ObjectID of the traversed street feature. Summarizing the values for this field can provide useful information such as the number of times a particular street feature is included in all the routes.	Long
RouteEdgeID	The ID representing the edge that comprises the street feature. Since there can be more than one edge per street feature, the SourceOID field can be used to uniquely identify the traversed street feature, and the RouteEdgeID field can be used to uniquely identify the edge within the traversed street feature.	Long
FromPosition	Specifies where the output RouteEdges feature begins in reference to the digitized direction of the underlying street feature. A value of 0 (zero) indicates the line begins at the from-point of the underlying street feature. A value of 1 indicates the line begins at the to-point of the street feature. A value between 0 and 1 indicates the line begins at a point along the underlying street feature; for example, a value of 0.25 means the line begins 25 percent along the digitized direction of the underlying street feature.	Double
ToPosition	Specifies where the output RouteEdges feature ends in reference to the digitized direction of the underlying street feature. A value of 0 (zero) indicates the line ends at the from-point of the underlying street feature. A value of 1 indicates the line ends at the to-point of the street feature. A value between 0 and 1 indicates the line ends at a point along the underlying street feature; for example, a value of 0.25 means the line ends 25 percent along the digitized direction of the underlying street feature.	Double
RouteID	Uniquely identifies the route that traversed the edge. The RouteID value corresponds to an ObjectID value from the output_routes feature class.	Long
Attr_Minutes	The travel time in minutes of the traversed portion of the underlying street feature.	Double
Attr_Miles	The length in miles of the traversed portion of the underlying street feature.	Double
Attr_Kilometers	The length in kilometers of the traversed portion of the underlying street feature.	Double
Attr_<TimeUnits>		Double
Attr_<DistanceUnits>		Double
Cumul_Minutes	The travel time in minutes of the route from its origin to the end of the traversed portion of this underlying street feature.	Double
Cumul_Miles	The length in miles of the route from its origin to the end of the traversed portion of this underlying street feature.	Double
Cumul_Kilometers	The length in kilometers of the route from its origin to the end of the traversed portion of this underlying street feature.	Double
Cumul_<TimeUnits>		Double
Cumul_<DistanceUnits>		Double
Attr_[Soft Restriction Attribute Name]	Specifies whether the traversed edge used the soft restriction attribute referred to in this field's name. 0—The traversed edge didn't use the soft restriction. 1—The traversed edge used the soft restriction. For example, if the analysis was performed using the soft restriction called Avoid Toll Roads, a field called Attr_Avoid_Toll_Roads is created for this soft restriction. A value of 1 for this field would represent the toll roads in the route.

Output Directions

Field

Description

Data type

RouteName

The name of the route to which the driving action applies. This value is the same as the Name field of the output_routes parameter.

String

ArriveTime

The time of day to initiate the given driving action. If the route spans multiple days, the date and time of day are displayed.

Date

Type

The type of maneuver that the directions feature represents or the type of the directions text. To determine whether Type refers to a maneuver type or a directions string type, you need to check the value of the SubItemType field.

Type can be used, for example, to assign an icon for a direction text based on the maneuver type, or it can use a formatting style based on the directions string type when displaying the driving directions in your application.

The Type value is an integer from the Maneuver Types or Directions String Types table listed below.

Maneuver Types


Value	Description
0	Unknown
1	Arrive at Stop
2	Go straight
3	Bear left
4	Bear right
5	Turn left
6	Turn right
7	Make sharp left
8	Make sharp right
9	Make U-turn
10	Take ferry
11	Take roundabout
12	Merge to highway
13	Exit highway
14	Go on another highway
15	At fork keep center
16	At fork keep left
17	At fork keep right
18	Depart stop
19	Trip planning item
20	End of ferry
21	Ramp right
22	Ramp left
23	Turn left and immediately turn right
24	Turn right and immediately turn left
25	Turn right and immediately turn right
26	Turn left and immediately turn left

Directions String Types


Value	Description
0	General directions string type
1	Depart directions string type
2	Arrive directions string type
3	Length directions string type
4	Time directions string type
5	Time summary directions string type
6	Time Window directions string type
7	Violation Time directions string type
8	Wait Time directions string type
9	Service Time directions string type
10	Estimated Arrival Time directions string type
11	Cumulative Length directions string type
12	Street name directions string type
13	Alternate street name directions string type
14	Sign branch information directions string type
15	Sign toward information directions string type
16	Cross street name directions string type
17	Sign exit number directions string type

Short

SubItemType

Specifies whether the Type field refers to an integer from the Directions String Types table or the Maneuver Types table.

If the SubItemType value is 1, the Type refers to the values from the Maneuver Types table.
If the SubItemType value is 2, the Type refers to the values from the Directions String Types table.

Short

Text

A text description of the driving directions.

String

ElaspsedTime

The time elapsed in minutes from when the current driving direction starts until the next one starts, or until the route ends for the last driving direction.

Double

DriveDistance

The distance from where the current driving direction occurs to where the next one occurs, or to where the route ends for the last driving direction. The value is in the units specified by the distance_units parameter.

This value is zero for driving directions that occur at the same location where the next one begins. For example, the DriveDistance is 0 for the directions text at the start of the route.