Skip To Content

Route output data types

Describe the output data types containing the results from a route analysis.

Routes

Provides access to the resulting routes.

The data type supports the following fields:

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

StartTime

The start time of the route, reported in the time zone in which the first stop is located.

Date

EndTime

The end time of the route, reported in the time zone in which the last stop is located.

Date

StartTimeUTC

The start time of the route in Coordinated Universal Time (UTC).

Date

EndTimeUTC

The end time of the route in Coordinated Universal Time (UTC).

Date

Total_Minutes

The cumulative travel time in minutes from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalTime if specified for the visited stops.

Note:

An additional field Total_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsTotal_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

Total_Miles

The cumulative travel distance in miles from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalDistance if specified for the visited stops.

Double

Total_Kilometers

The cumulative travel distance in kilometers from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalDistance if specified for the visited stops.

Note:

An additional field Total_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Miles or DistanceUnits.Kilometers. The field values are in the units specified by the distanceUnits property.

Note:

Additional fieldsTotal_[AccumulateAttributeName]_[DistanceUnits] are included for each distance-based cost attribute that is accumulated during the analysis.

Double

Total_Other

The cumulative travel cost in unknown units from the beginning of the first stop to the end of the last stop for a route. This includes any AdditionalCost if specified for the visited stops.

This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based.

Note:

Additional fieldsTotal_[AccumulateAttributeName]_Other are included for each cost attribute that is neither time-based or distance-based and accumulated during the analysis.

Double

TotalWait_Minutes

This field stores the route's overall wait time, which is the time spent at stops waiting for time windows to open.

The field has null value if time windows are not used in the analysis.

Note:

An additional field TotalWait_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsTotalWait_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

TotalViolation_Minutess

This field stores the route's overall violation time at stops. Violation time is added when the route arrives at a stop after the time window has ended; it's the difference between the ArriveTime and TimeWindowEnd fields on inputs stops.

The field has null value if time windows are not used in the analysis.

Note:

An additional field TotalViolation_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Additional fieldsTotalViolation_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

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

RouteEdges

Provides access to the individual network edges along which the routes travel.

The data type supports the following fields:

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 (RouteOutputDataType.Routes data type).

Long

Attr_Minutes

The travel time in minutes of the traversed portion of the underlying street feature.

Note:

An additional field Attr_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

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.

Note:

An additional field Attr_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Miles or DistanceUnits.Kilometers. The field values are in the units specified by the distanceUnits property.

Double

Attr_Other

The travel cost of the traversed portion of the underlying street feature. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based. The value is in unknown units.

Note:

Additional fieldsAttr_[AccumulateAttributeName] are included for each cost attribute that is neither time-based or distance-based and accumulated during the analysis.

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.

Note:

An additional field Cumul_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsCumul_[AccumulateAttributeName] are included for each time-based cost attribute that is accumulated during the analysis. The values are in the time units used for the analysis.

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.

Note:

An additional field Cumul_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Miles or DistanceUnits.Kilometers. The field values are in the units specified by the distanceUnits property.

Note:

Additional fieldsCumul_[AccumulateAttributeName] are included for each distance-based cost attribute that is accumulated during the analysis. The values are in the distance units used for the analysis.

Double

Cumul_Other

The travel cost of the route from its origin to the end of the traversed portion of this underlying street feature. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based. The value is in unknown units.

Note:

Additional fieldsCumul_[AccumulateAttributeName] are included for each cost attribute that is neither time-based or distance-based and accumulated during the analysis.

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.

Directions

Provides access to the turn-by-turn directions for each resulting route.

The data type supports the following fields:

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.

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

ValueDescription

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

ValueDescription

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 directionsDistanceUnits property of the analysis object.

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.

Double

Stops

Provides access to the attributes of the stops that are visited by the routes as well as stops that cannot be reached by any of the routes. You can use the attributes from this data type, such as the Status field, to determine why a stop was not assigned to any routes.

The data type supports the following fields. In addition to these fields, the data type also includes all the fields from the input feature class used as stops for the analysis.

Field

Description

Data type

Name

The name of the stop visited by the route. The values for this field are copied from the Name field on input stops.

String

RouteName

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.

String

Sequence

The order in which the stops are visited by the assigned route, which is listed in the RouteName field.

Long

TimeWindowStart

The earliest time the route can visit the stop. The values for this field are copied from the TimeWindowStart field on input stops.

Date

TimeWindowEnd

The latest time the route can visit the stop. The values for this field are copied from the TimeWindowEnd field on input stops.

Date

ArriveCurbApproach

The side of the vehicle the curb is on when arriving at the stop.

Long

DepartCurbApproach

The side of the vehicle the curb is on when departing from the stop.

Long

ArriveTime

The date and time value indicating the arrival time at the stop. The time zone for this time-of-day value is taken from the network element on which the stop is located.

Date

DepartTime

The date and time value indicating the departure time from the stop. The time zone for this time-of-day value is taken from the network element on which the stop is located.

Date

ArriveTimeUTC

The date and time value indicating the arrival time in Coordinated Universal Time (UTC)

Date

DepartTimeUTC

The date and time value indicating the departure time in Coordinated Universal Time (UTC)

Date

LocationType

The stop type. The values for this field are copied from the LocationType field on input stops.

Long

SourceID

The numeric identifier of the source feature class containing the source feature that the network location is located on.

Long

SourceOID

The numeric identifier of the source feature in the source feature class.

Long

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. For example a value of 0.47 indicates that the point is positioned 47 percent from the start of the source line feature.

Double

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. The field can have two possible values. A value of 1 indicates the point is on the right side of the line feature and a value of 0 indicates the point is on the left side of the line feature.

Double

CurbApproach

The direction a vehicle may arrive at and depart from the stop. The values for this field are copied from the CurbApproach field on input stops.

Long

Status

Indicates how the stop was evaluated in the analysis. The field can be used to determine which stops were not assigned to any routes. The possible values are the following:

  • 0 (OK)—The stop was successfully located on the transportation network and analyzed.
  • 1 (Not Located)—The stop was not included in the analysis since a traversable road was not found within the maximum search distance from the stop.
  • 4 (Not Reached)—The stop couldn't be reached due to constraints; for example, a curb approach is set so that a vehicle must travel in the wrong direction on a one-way street to reach the stop.
  • 6 (Time window violation)—Time windows on the route cannot be reached on time; the route arrives early or late.
  • 7 (Not located on closest)— The closest network location to the stop is not traversable because of a restriction or barrier, so the stop has been located on the closest traversable network feature instead.

Long

SnapX

The x-coordinate value for the computed network location.

Double

SnapY

The y-coordinate value for the computed network location.

Double

SnapZ

The z-coordinate value for the computed network location.

The field has a non-zero value only when the input network dataset supports connectivity based on z-coordinate values of the network sources.

Double

DistanceToNetworkInMeters

The distance, in meters, between the location of the point feature and its computed network location.

Double

AdditionalTime

The amount of time added to the total route time when this stop is visited. The values for this field are copied from the AdditionalTime field on input stops.

Double

AdditionalDistance

The amount of distance added to the total route distance when this stop is visited. The values for this field are copied from the AdditionalDistance field on input stops.

Double

AdditionalCost

The cost added to the total route cost when this stop is visited. The values for this field are copied from the AdditionalCost field on input stops. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based.

Double

Cumul_Minutes

The cumulative duration of the route in minutes from the origin to and including the stop. The value reported here is the cumulative route time to the stop, including any additional time at the stop and at any previous stops.

For example, If a route analysis determines it takes 10 minutes to visit two stops, and the second stop has an AdditionalTime value of 5, the Cumul_Minutes value will be 15 minutes.

Note:

An additional field Cumul_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsCumul_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

Cumul_Miles

The cumulative distance of the route in miles from the origin to and including the stop. The value reported here is the cumulative route distance to the stop, including any additional distance at the stop and at any previous stops.

Note:

An additional field Cumul_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Miles or DistanceUnits.Kilometers. The field values are in the units specified by the distanceUnits property.

Note:

Additional fieldsCumul_[AccumulateAttributeName]_[DistanceUnits] are included for each distance-based cost attribute that is accumulated during the analysis.

Double

Cumul_Kilometers

The cumulative distance of the route in kilometers from the origin to and including the stop. The value reported here is the cumulative route distance to the stop, including any additional distance at the stop and at any previous stops.

Double

Cumul_Cost

The cumulative cost of the route from the origin to and including the stop. The value reported here is the cumulative route cost to the stop, including and additional cost at the stop and at any previous stops. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time-based or distance-based. The value is in unknown units.

Note:

Additional fieldsCumul_[AccumulateAttributeName]_Other are included for each cost attribute that is neither time-based or distance-based and accumulated during the analysis.

Double

Wait_Minutes

This field stores the time spent waiting for the time window to open when the route arrives early at the stop.

The field has null value if time windows are not used in the analysis.

Note:

An additional field Wait_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Note:

Additional fieldsWait_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

CumulWait_Minutes

This field stores a sum of how much time has been spent waiting for time windows to open. It measures idle time. It includes the wait time from the current stop and all previous stops visited by the route.

The field has null value if time windows are not used in the analysis.

Note:

An additional field CumulWait_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Additional fieldsCumulWait_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

Violation_Minutes

This field is a measure of how late the route arrived after the time window closed. Specifically, it stores the amount of time between the end of the time window and when the route arrived at the stop.

The field has null value if time windows are not used in the analysis.

Note:

An additional field Violation_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Additional fieldsViolation_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

CumulViolation_Minutes

This field stores the cumulative violation time from the current stop and all previous stops visited by the route.

The field has null value if time windows are not used in the analysis.

Note:

An additional field CumulViolation_[TimeUnits] is included if the timeUnits property of the analysis object is not set to TimeUnits.Minutes. The field values are in the units specified by the timeUnits property.

Additional fieldsCumulViolation_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

ORIG_FID

The ObjectID of the input stop. This field can be used to join attributes from the output stops to the input stops or from the input stops to the output stops.

Long

Bearing

The values for this field are copied from the Bearing field on the input stops.

Double

BearingTol

The values for this field are copied from the BearingTol field on the input stops.

Double

NavLatency

The values for this field are copied from the NavLatency field on the input stops.

Double