Skip to main content

Route output data types

The output data types containing the results from a route analysis are described.

Routes

This provides access to the resulting routes.

The data type supports the following fields:

Field

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

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 stops.

Text

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 values for the visited stops if specified.

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 fields, Total_[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 values for the visited stops if specified.

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 values for the visited stops if specified.

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 fields, Total_[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 values for the visited stops if specified.

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

Note:

Additional fields, Total_[AccumulateAttributeName]_Other, are included for each cost attribute that is neither time based nor 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 a 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 fields, TotalWait_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis.

Double

TotalViolation_Minutes

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 field values on inputs stops.

The field has a 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 fields, TotalViolation_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis.

Double

FirstStopID

This field corresponds to the ObjectID field value in the output Stops table of the first stop on the route. It can be used for joins between these two tables.

Long

FirstStopOID

The ORIG_FID field value in the output Stops table corresponding to the first stop on the route.

Long

LastStopID

This field corresponds to the ObjectID field value in the output Stops table of the last stop on the route. It can be used for joins between these two tables.

Long

LastStopOID

The ORIG_FID field value in the output Stops table corresponding to the last stop on the route.

Long

RouteEdges

This provides access to the individual network edges along which the routes travel.

The data type supports the following fields:

Field

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

SourceName

The name of the edge source feature class from which the line was generated.

Text

SourceOID

The ObjectID value 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 that the line begins at the from point of the underlying street feature.

  • A value of 1 indicates that the line begins at the to point of the street feature.

  • A value between 0 and 1 indicates that 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 that the line ends at the from point of the underlying street feature.

  • A value of 1 indicates that the line ends at the to point of the street feature.

  • A value between 0 and 1 indicates that 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

FromJunctionID

The ObjectID of the feature in the RouteJunctions feature class that is coincident with the beginning of the RouteEdges feature.

Long

ToJunctionID

The ObjectID of the feature in the RouteJunctions feature class that is coincident with the end of the RouteEdges feature.

Long

RouteID

Uniquely identifies the route that traversed the edge.

This field corresponds to the ObjectID field in the output Routes table and can be used for joins between these two tables.

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 nor distance based. The value is in unknown units.

Note:

Additional fields, Attr_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor 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 fields, Cumul_[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 fields, Cumul_[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 nor distance based. The value is in unknown units.

Note:

Additional fields, Cumul_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor 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.

Long

RouteJunctions

This provides access to the individual network junctions through which the routes passed.

The data type supports the following fields:

Field

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

SourceName

The name of the junction source feature class from which the point was generated.

Text

SourceOID

The ObjectID value of the traversed junction feature. Summarizing the values for this field can provide useful information such as the number of times a particular junction feature is included in all the routes.

Long

RouteJunctionID

The ID representing the junction. This ID may be the same as the SourceOID value for junctions derived from the network, but it can also include the ObjectID value of stops visited by the route.

Long

RouteID

Uniquely identifies the route that traversed the junction.

This field corresponds to the ObjectID field in the output Routes table and can be used for joins between these two tables.

Long

Attr_Minutes

The travel time in minutes to traverse the junction.

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 added to the route by traversing the junction.

Double

Attr_Kilometers

The length in kilometers added to the route by traversing the junction.

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 junction. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based. The value is in unknown units.

Note:

Additional fields, Attr_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis.

Double

Cumul_Minutes

The travel time in minutes of the route from its origin through this junction.

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 fields, Cumul_[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 through this junction.

Double

Cumul_Kilometers

The length in kilometers of the route from its origin through this junction.

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 fields, Cumul_[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 through this junction. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based. The value is in unknown units.

Note:

Additional fields, Cumul_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis.

Double

Attr_[Soft Restriction Attribute Name]

Specifies whether the traversed junction used the soft restriction attribute referred to in this field's name.

  • 0—The traversed junction didn't use the soft restriction.

  • 1—The traversed junction 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.

Long

RouteTurns

This provides access to the network turns traversed by the routes.

The data type supports the following fields:

Field

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

SourceName

The name of the turn source feature class from which the line was generated.

Text

SourceOID

The ObjectID value of the traversed turn feature.

Long

RouteTurnID

The ID representing the turn. This ID is typically the same as the SourceOID value.

Long

FromEdgeID

The ObjectID value of the line feature in the RouteEdges output that is coincident with the beginning of the turn.

Long

ToEdgeID

The ObjectID value of the line feature in the RouteEdges output that is coincident with the end of the turn.

Long

RouteID

Uniquely identifies the route that traversed the turn.

This field corresponds to the ObjectID field in the output Routes table and can be used for joins between these two tables.

Long

Attr_Minutes

The travel time in minutes to traverse the turn.

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 added to the route by traversing the turn.

Double

Attr_Kilometers

The length in kilometers added to the route by traversing the turn.

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 turn. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based. The value is in unknown units.

Note:

Additional fields, Attr_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis.

Double

Cumul_Minutes

The travel time in minutes of the route from its origin through this turn.

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 fields, Cumul_[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 through this turn.

Double

Cumul_Kilometers

The length in kilometers of the route from its origin through this turn.

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 fields, Cumul_[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 through this turn. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based. The value is in unknown units.

Note:

Additional fields, Cumul_[AccumulateAttributeName], are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis.

Double

Attr_[Soft Restriction Attribute Name]

Specifies whether the traversed turn used the soft restriction attribute referred to in this field's name.

  • 0—The traversed turn didn't use the soft restriction.

  • 1—The traversed turn 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.

Long

Directions

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

Legacy:

This output class has been superseded by the DirectionPoints and DirectionLines output classes, which should be used for all new scripts and workflows. The Directions output class will be removed in a future release.

The data type supports the following fields:

Field

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

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.

Text

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, review the SubItemType field value.

Type can be used, for example, to assign an icon for 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 the application.

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

Maneuver Types

  • 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

  • 27: Pedestrian ramp

  • 28: Elevator

  • 29: Escalator

  • 30: Stairs

  • 31: Door passage

Directions String Types

  • 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 field refers to the values from the Maneuver Types table.

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

  • If the SubItemType value is 3, the Type field refers to the values from the Directions String Types table.

Short

Text

A text description of the travel 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.

Float

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 value is 0 for the directions text at the start of the route.

Float

Stops

This 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 parameter, such as the Status field, to determine why a stop was not assigned to any routes.

The data type supports the fields described below. 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

ObjectID

The object ID of the feature.

ObjectID

Name

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

Text

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 provided, all the stops belong to the same route.

Text

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 the 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 the 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 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

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 the input stops.

Long

SourceID

The numeric identifier of the network dataset source feature class on which the input point is located.

Long

SourceOID

The ObjectID of the feature in the source on which the input point is located.

Long

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

Double

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

Long

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 the input stops.

Long

Status

Specifies the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are the following:

  • 0 (OK)—The point was located on the network.

  • 1 (Not Located)—The point was not located on the network and was not included in the analysis.

  • 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.

  • 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.

  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.

  • 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.

  • 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.

  • 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.

Long

SnapX

The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

Double

SnapY

The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

Double

SnapZ

The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ field is 0 if the network is two dimensional.

Double

DistanceToNetworkInMeters

The distance in meters between the point's geographic location and the position where it was located on the network.

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 the 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 the 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 the input stops. This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor 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 that 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 fields Cumul_[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 fields, Cumul_[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 any 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 nor distance based. The value is in unknown units.

Note:

Additional fields, Cumul_[AccumulateAttributeName]_Other, are included for each cost attribute that is neither time based nor 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 a 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 fields, Wait_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis.

Double

CumulWait_Minutes

This field stores the 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 a 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 fields, CumulWait_[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 a 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 fields, Violation_[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 a 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 fields, CumulViolation_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis.

Double

ORIG_FID

The ObjectID value of the input stop feature.

This field is not always reliable for joins. This field is null for inputs added to the analysis using the insertCursor method. Values may not be unique if multiple feature classes were loaded using the load method.

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

DirectionPoints

This is the output turn-by-turn directions for the routes calculated in the analysis, represented as point locations along the routes where specific direction events or maneuvers occur.

The data type supports the following fields:

Field name

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

RouteID

The ObjectID value of the output Routes feature with which this direction point is associated.

Long

Sequence

The sequence of the direction points for the route, starting with 1.

Long

DirectionPointType

Specifies the type of direction event or maneuver described by the point, designated by one of the values below.

  • Header (1)

  • Arrive (50)

  • Depart (51)

  • Straight (52)

  • On Ferry (100)

  • Off Ferry (101)

  • Central Fork (102)

  • Roundabout (103)

  • U-Turn (104)

  • Door (150)

  • Stairs (151)

  • Elevator (152)

  • Escalator (153)

  • Pedestrian Ramp (154)

  • Left Fork (200)

  • Left Ramp (201)

  • Clockwise Roundabout (202)

  • Left-handed U-turn (203)

  • Bear left (204)

  • Left Turn (205)

  • Sharp Left (206)

  • Left Turn and immediate Left Turn (207)

  • Left Turn and immediate Right Turn (208)

  • Right Fork (300)

  • Right Ramp (301)

  • Counter-Clockwise Roundabout (302)

  • Right-handed U-turn (303)

  • Bear right (304)

  • Right Turn (305)

  • Sharp Right (306)

  • Right Turn and immediate Left Turn (307)

  • Right Turn and immediate Right Turn (308)

  • Up Elevator (400)

  • Up Escalator (401)

  • Up Stairs (402)

  • Down Elevator (500)

  • Down Escalator (501)

  • Down stairs (502)

  • General Event (1000)

  • Landmark (1001)

  • Time Zone Change (1002)

  • Traffic Event (1003)

  • Scaled Cost Barrier Event (1004)

  • Boundary Crossing (1005)

  • Restriction Violation (1006)

  • Lane (1007)

Long

StopID

The ObjectID value of the output Stops feature with which this direction point is associated, if any. If the point does not represent a visit to a stop, the value is null.

Long

DisplayText

The directions text that will be displayed in the consuming application.

Text

ArrivalTime

The time the direction event occurs in coordinated universal time (UTC).

Date

ArrivalUTCOffset

The difference in minutes between the local time at the maneuver location and UTC time shown in the ArrivalTime field.

Double

Name

The name of the direction point.

Text

ExitName

The highway exit name that appears in the directions instruction.

Text

AlternateName

The alternate source name that appears in the directions instruction.

Text

IntersectingName

The name of the intersecting or cross street that appears in the directions instruction.

Text

BranchName

The signpost branch name that appears in the directions instruction.

Text

TowardName

The signpost toward destination name that appears in the directions instruction.

Text

Level

The building level at which this direction event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long

ShortVoiceInstruction

The short text that will be used as voice guidance text in the consuming application.

Text

VoiceInstruction

The additional text, including expanded abbreviations and plurals, that will be used as voice guidance text in the consuming application.

Text

Azimuth

The bearing in degrees of the vehicle departing this point. Zero indicates north.

Double

DirectionLines

This is the output route lines calculated in the analysis sliced to represent each route segment between DirectionPoints events or maneuver locations.

Field name

Description

Data type

ObjectID

The object ID of the feature.

ObjectID

DirectionPointID

The ObjectID value of the feature in the DirectionPoints table with which this line is associated.

Long

RouteID

The ObjectID value of the output Routes feature with which this direction line is associated.

Long

DirectionLineType

Specifies the type of direction situation described by this line, designated by one of the following values:

  • Unknown (0)

  • Segment (1)

  • Maneuver Segment (2)

  • Restriction violation (3)

  • Scaled Cost Barrier (4)

  • Heavy Traffic (5)

  • Slow Traffic (6)

  • Moderate Traffic (7)

Long

Meters

The length of the line segment measured in meters.

Double

Minutes

The travel time along the line segment in minutes.

Double

FromLevel

The building level at which this direction event begins. This value corresponds to the Level property defined in the network dataset used for the analysis.

Learn more about the directions configuration of a network dataset

Long

ToLevel

The building level at which this direction event ends. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long