The Find Routes geoprocessing tool produces layers representing stops, routes, directions, and route edges. The output feature classes and their corresponding field attributes are described in this topic.
Routes feature class
The Routes line feature class represents the best paths between the stops.
The default name of this output feature class is Routes, but you can give it a different name by changing the Output Routes Name parameter (Output_Routes_Name in Python) prior to solving.
The feature class is assigned the same coordinate system that the underlying network dataset uses. This can be controlled by specifying a value for the Output Coordinate System geoprocessing environment.
The field names of the Routes feature class are listed and described below.
Field name | Description |
---|---|
OID | The system-managed ID field. |
Shape | The geometry field indicating the shape of the lines. |
Name | The name of the route is copied from the RouteName field of the stops it was assigned to visit. If the input RouteName field of stops was null, the name is derived from the names of the first and last stops. Input stops that have the same route name at the time the tool runs are grouped together and visited by one route and the route is assigned that name. When more than one route name is present on the input stops, the tool can output multiple routes—one for each unique route name. |
StopCount | The number of stops assigned to the route. |
Total_[Units] | The total time or distance of the route. Total_Minutes,Total_Miles, and Total_Kilometers are always present. Another field is present if the Measurement Units input parameter was set to a different unit. |
Total_[Accumulated Cost Attribute]_[Units] | The total time or distance of the route based on a cost attribute chosen in the Accumulate Attributes input parameter. The units of the specified cost attribute are converted to the units that were set in the Measurement Units input parameter. |
TotalWait_[Time Attribute] | The total amount of time the route spends in front of a stop waiting for its time window to open. For example, if a stop has a time window of 3:00 to 4:00 p.m., and the route arrives at 2:55 p.m., the wait time at that stop is 5 minutes. This field value is the sum of the wait times at all stops. |
TotalViolation_[Time Attribute] | The total amount of the route's time-window violation time. If a route arrives at a stop 5 minutes after the stop's time window ends, the violation time at that stop is 5 minutes. This field is the sum of the violation times at all stops. |
StartTime | The time the route begins. |
EndTime | The time the route is complete. |
FirstStopOID | The OID identifier of the first stop on the route. |
LastStopOID | The OID identifier of the last stop on the route. |
Shape_Length | The geometric length of the feature. |
Stops feature class
The Stops feature class represents the stops that could and could not be reached by any of the routes. For those that couldn't be reached, the attribute table provides information on what was the source of the problem. For those that could be reached, the attribute table lists the route name assigned to the stops, the stop sequence, arrival time, and other information.
The default name of this output feature class is Stops, but you can give it a different name by changing the Output Stops Name parameter (Output_Stops_Name in Python) prior to solving.
The feature class is assigned the same coordinate system that the underlying network dataset uses. This can be controlled by specifying a value for the Output Coordinate System geoprocessing environment.
The field names of the Stops feature class are listed and described below.
Field name | Description |
---|---|
OID | The system-managed ID field. |
Shape | The geometry of the point, which is stored internally. |
Name | The name of the stop. If the input stops feature class had a field with the same name, this Name value is derived from that field; otherwise, the Name value is assigned a default value. |
RouteName | This represents the name of the route to which the stop is assigned. Input stops that have the same route name at the time the tool runs are grouped together and visited by one route and the route is assigned that name. When more than one route name is present on the input stops, the tool can output multiple routes—one for each unique route name. If no name is present, all the stops belong to the same route. |
Sequence | The order in which the stop is visited by the assigned route, which is listed in the RouteName field. A stop with a Sequence value of 3 indicates the assigned route visits two stops before visiting the stop in question. |
TimeWindowStart | This field specifies the earliest time that the route can visit the stop. This field and its values are copied from the input stops. |
TimeWindowEnd | This field specifies the latest time that the route can visit the stop. This field and its values are copied from the input stops. |
Curb Approach | Specifies the direction a vehicle may arrive at and depart from the stop. This field and its values are copied from the input stops. |
ArriveCurbApproach | Indicates which side of the vehicle the curb is on when arriving at the stop. |
DepartCurbApproach | Indicates which side of the vehicle the curb is on when departing from the stop. |
Status | This field is constrained by a domain of values, which are listed below (their coded values are shown in parentheses). Note that network location refers to the location of the stop on the network dataset.
|
Additional Time | The amount of time added to the total route time when this stop is visited. This field and its values are copied from the input stops. The units for this field value are the same as those specified in the Measurement Units input parameter. |
Additional Distance | The amount of distance added to the total route distance when this stop is visited. This field and its values are copied from the input stops. The units for this field value are the same as those specified in the Measurement Units input parameter. |
Cumul_[Units] | The cumulative distance or duration of the route from the origin to and including the stop. The value reported here is the cumulative route time or distance to the stop, including any additional time or distance at the stop and at any previous stops. |
Cumul_[Attribute Name]_[Units] | The cumulative distance or duration of the route from the origin to and including the stop. The value reported here is the cumulative route time or distance to the stop, including any additional time or distance at the stop and at any previous stops. The units of the specified cost attribute are converted to the units that were set in the Measurement Units input parameter. |
ArriveTime | The time of day when the route arrives at the stop. When the network dataset is configured with time zones, the time-of-day value corresponds with the time zone in which the stop is located; otherwise, it corresponds with the time zone that is configured on the computer used to solve the analysis. |
DepartTime | The time of day when the route departs from the stop. When the network dataset is configured with time zones, the time-of-day value corresponds with the time zone in which the stop is located; otherwise, it corresponds with the time zone that is configured on the computer used to solve the analysis. |
ORIG_FID | The Object ID of the input stop. This field can be used to join attributes from the output Stops feature class to the input stops table or from the input stops to the output stops. It can also be used to join attributes to and from the output Stops feature class. |
Directions feature class
The Directions line feature class represents segments along routes between stops. It includes text directions for navigation assistance.
The default name of this output feature class is Directions, but you can give it a different name by changing the Directions Name (Output_Directions_Name in Python) parameter prior to solving.
The feature class is assigned the same coordinate system that the underlying network dataset uses. This can be controlled by specifying a value for the Output Coordinate System geoprocessing environment.
The field names of the Directions feature class are listed and described below.
Field Name | Description |
---|---|
ObjectID | The system-managed ID field. |
Shape | The geometry field indicating the shape of the lines. |
RouteName | The name of the route that the driving action applies to. |
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. |
Type | This field is for advanced users who want to customize the driving-directions text. Most users can meet their requirements by ignoring this field and referring to the Text field instead. Type refers to a constant in one of two enumerations: esriDirectionsManueverType or esriDirectionsStringType. (See the SubItemType field description to learn which enumeration the Type value refers to.) You can see a list of constant values by searching the SDK of your choice for the enumeration name. |
SubItemType | This field is for advanced users who want to customize the driving-directions text. Most users can meet their needs by ignoring this field and referring to the Text field instead. SubItemType works in combination with Type to create the driving direction shown in the Text field. The SubItemType field specifies whether the Type field refers to a constant value in the esriDirectionsManueverType enumeration or the esriDirectionsStringType enumeration.
|
Text | A text description of the driving direction. The text uses the style, units, and language you specified in the tool parameters. |
ElapsedTime | The time it takes to complete the maneuver. The units chosen in the Time Attribute Units parameter determine the units of the ElapsedTime field. Some driving directions include extra records for service time, violation time, and so on. In these cases, the elapsed time is replicated for each record. If you want to sum the total elapsed time, select those records with a Type value of 1 and sum those records. |
DriveDistance | The travel distance along this segment of the route. This value is zero for driving directions that occur at the same location where the next one begins. |
Shape_Length | The geometric length of the feature. |
RouteEdges feature class
The RouteEdges line feature class represents the individual road segments that the routes travel along.
The default name of this output feature class is RouteEdges, but you can give it a different name by changing the Output Route Edges Name (Output_Route_Edges_Name in Python) parameter prior to solving.
The feature class is assigned the same coordinate system that the underlying network dataset uses. This can be controlled by specifying a value for the Output Coordinate System geoprocessing environment.
The field names of the RouteEdges feature class are listed and described below.
Field Name | Description | |
---|---|---|
ObjectID | The system-managed ID field. | |
Shape | The geometry field indicating the shape of the lines. | |
SourceName | The name of the edge source feature class from which the line was generated. | |
SourceOID | The object ID of the traversed source feature. This value is an object ID from the feature class that is identified in the SourceName field. | |
RouteEdgeID | The ID representing the network dataset edge that was traversed by the route. Object IDs uniquely identify features and edge IDs uniquely identify edges, and there may be more than one edge per line feature. | |
FromPosition | Specifies where the output RouteEdges feature begins in reference to the digitized direction of the underlying source feature.
| |
ToPosition | Specifies where the output RouteEdges feature ends in reference to the digitized direction of the underlying source feature.
| |
RouteID | Uniquely identifies the route that traversed the edge. The RouteID value corresponds to an OID value from the output Routes feature class. | |
Attr_[Units] | The travel time or length of the traversed portion of the underlying source feature. | |
Attr_[Cost Attribute]_[Units] | The travel time or length of the traversed portion of the underlying source feature according to the cost attribute name. The units of the specified cost attribute are converted to the units that were set in the Measurement Units input parameter. | |
Cumul_[Units] | The travel time or length of the route from its origin to the end of the traversed portion of this underlying source feature. | |
Cumul_[Cost Attribute]_[Units] | The travel time or length of the route from its origin to the end of the traversed portion of this underlying source feature. The units of the specified cost attribute are converted to the units that were set in the Measurement Units input parameter. | |
Attr_[Restriction Attribute] | Specifies whether the traversed edge used the restriction attribute referred to in this field's name.
| |
Shape_Length | The geometric length of the feature. |