OriginDestinationCostMatrix output data types

Describes the output data types containing the results from an origin-destination cost matrix analysis.

Lines

This provides access to the lines connecting the origins to the destinations.

The data type supports the following fields:

Field	Description	Data type
ObjectID	The object ID of the feature.	ObjectID
OriginID	This field corresponds to the ObjectID field in the output Origins table and can be used for joins between these two tables.	Long
OriginOID	This field corresponds to the OriginOID field in the output Origins table.	Long
DestinationID	This field corresponds to the ObjectID field in the output Destinations table and can be used for joins between these two tables.	Long
DestinationOID	This field corresponds to the DestinationOID field in the output Destinations table.	Long
DestinationRank	The rank of the destination among all destinations found for the associated origin. The destination that is closest to the origin has a rank of 1.	Long
Total_Time	The travel time along the street network between the associated origin and destination. The field value is in the units specified by the timeUnits property of the analysis object. Note: Additional fields Total_[AccumulateAttributeName]_[TimeUnits] are included for each time-based cost attribute that is accumulated during the analysis.	Double
Total_Distance	The travel distance along the street network between the associated origin and destination. The field value is in the units specified by the distanceUnits property of the analysis object. Note: Additional fields Total_[AccumulateAttributeName]_[DistanceUnits] are included for each distance-based cost attribute that is accumulated during the analysis.	Double
Total_Other	The travel cost in unknown units along the street network between the associated origin and destination. 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
OriginName	The name of the corresponding input origin feature. This field is included only if the Name field is specified on input origins and at least one of the origins has a valid name. If the name is not provided for some of the origins, an automatically generated name prefixed with Location is created for those origins.	Text
DestinationName	The name of the corresponding input destination feature. This field is included only if the Name field is specified on input destinations and at least one of the destinations has a valid name. If the name is not provided for some of the destinations, an automatically generated name prefixed with Location is created for those destinations.	Text

Origins

This provides information about the origins used in the analysis such as the total number of destinations reached from a given origin, or the origins that could not be included in the analysis.

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 origins for the analysis.

Field	Description	Data type
ObjectID	The object ID of the feature.	ObjectID
Name	The name of the origin. If the name of the origin was provided as part of the Name field, this field has the same value. Otherwise, it includes an automatically generated value prefixed with Location.	Text
OriginOID	The ObjectID value of the input origin 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
DestinationCount	A count of destinations that were reached from the origin.	Long
TargetDestinationCount	The value of the TargetDestinationCount field in the corresponding input origins.	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 value of the CurbApproach field in the corresponding input origins.	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
Cutoff	The value of the Cutoff field in the corresponding input origins.	Double
Bearing	The values for this field are copied from the Bearing field on the input facilities.	Double
BearingTol	The values for this field are copied from the BearingTol field on the input facilities.	Double
NavLatency	The values for this field are copied from the NavLatency field on the input facilities.	Double

Destinations

This provides information about the destinations used in the analysis such as the total number of origins that were reached from a given origin, or the destinations that could not be included in the analysis.

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 origins for the analysis.

Field	Description	Data type
ObjectID	The object ID of the feature.	ObjectID
Name	The name of the destination. If the name for the origin was provided as part of the Name field, this field has the same value. Otherwise, it includes an automatically generated value prefixed with Location.	Text
DestinationOID	The ObjectID value of the input destination 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
OriginCount	The number of origins that reached the destination.	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 value of the CurbApproach field in the corresponding input destinations.	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
Bearing	The values for this field are copied from the Bearing field on the input facilities.	Double
BearingTol	The values for this field are copied from the BearingTol field on the input facilities.	Double
NavLatency	The values for this field are copied from the NavLatency field on the input facilities.	Double