Skip To Content

OriginDestinationCostMatrix output data types

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

Lines

Provides access to the lines connecting the origins to the destinations.

The data type supports the following fields:

Field

Description

Data type

OriginOID

The ObjectID value of the corresponding input origin feature. This can be used to join additional attributes between the input origins and the origin destination lines.

Long

DestinationOID

The object ID value of the corresponding input destination feature. This can be used to join additional attributes between the input destinations and the origin destination lines.

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 fieldsTotal_[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 fieldsTotal_[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 or 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 specified 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 specified for some of the destinations, an automatically generated name prefixed with Location is created for those destinations.

Text

Origins

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 include all the fields from the input feature class used as origins for the analysis

Field

Description

Data type

Name

The name of the origin. If the name of the origin was specified as part of the Name field, this field has the same value. Otherwise it includes an automatically generated value prefixed with Location.

String

OriginOID

The ObjectID value of the corresponding input origin feature. This can be used to join additional attributes from the input origins.

Double

DestinationCount

A count of destinations that were reached from the origin.

Long

TargetDestinationCount

The value of the TargetDestinationCount field in the corresponding input origins.

Integer

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.

Long

CurbApproach

The value of the CurbApproach field in the corresponding input origins.

Long

Status

Indicates how the corresponding input origin was evaluated in the analysis. The possible values are the following:

  • 0 (OK)—The origin was successfully located on the transportation network and analyzed.
  • 1 (Not Located)—The origin was not included in the analysis since a traversable road was not found within the maximum search distance from the origin.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain.
  • 5 (Not Reached)—The origin could not find routes to any destinations 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 destination, or no destinations are within the specified travel time or travel distance based cutoff.
  • 7 (Not located on closest)— The closest network location to the origin is not traversable because of a restriction or barrier, so the origin 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

Cutoff

The value of the Cutoff field in the corresponding input origins.

Double

TargetDestinationCount

The value of the TargetDestinationCount field in the corresponding input origins.

Integer

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

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 include all the fields from the input feature class used as origins for the analysis

Field

Description

Data type

Name

The name of the destination. If the name for the origin was specified as part of the Name field, this field has the same value. Otherwise it includes an automatically generated value prefixed with Location.

String

DestinationOID

The ObjectID value of the corresponding input destination feature. This can be used to join additional attributes from the input destinations.

Integer

OriginCount

The number of origins that were able to reach the destination.

Integer

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.

Long

CurbApproach

The value of the CurbApproach field in the corresponding input destinations.

Integer

Status

Indicates how the corresponding input destination was evaluated in the analysis. The possible values are the following:

  • 0 (OK)—The destination was successfully located on the transportation network and analyzed.
  • 1 (Not Located)—The destination was not included in the analysis since a traversable road was not found within the maximum search distance from the destination.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain.
  • 5 (Not Reached)—The origin could not find routes to any destinations 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 destination, or no destinations are within the specified travel time or travel distance based cutoff.
  • 7 (Not located on closest)— The closest network location to the destination is not traversable because of a restriction or barrier, so the destination has been located on the closest traversable network feature instead.

Integer

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

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