Skip To Content

ClosestFacility output data types

Describes the output data types containing the results from a closest facility analysis.

ClosestFacilities and Facilities

Provides access to the output facilities from a closest facility analysis.

ClosestFacilities data type includes only those facilities from the set of input facilities that were closest to at least one incident. On the other hand, Facilities data type includes all the facilities from the analysis including the facilities that cannot be reached from any of the incidents. You can use the Status field from the Facilities data type, to determine why a facility was not used in the analysis.

These data types supports the following fields. In addition to these fields, the data types also include all the fields from the input feature class used as facilities for the analysis.

Field nameDescriptionData type

Name

The name of the facility. The values for this field are copied from the Name field on input facilities.

Text

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 direction a vehicle may arrive at and depart from the facility. The values for this field are copied from the CurbApproach field on input facilities.

Long

Status

Indicates how the facility was evaluated in the analysis. The possible values are the following:

  • 0 (OK)—The facility was successfully located on the transportation network and analyzed.
  • 1 (Not Located)—The facility was not included in the analysis since a traversable road was not found within the maximum search distance from the facility.
  • 4 (Not Reached)—The facility 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 facility.
  • 7 (Not located on closest)— The closest network location to the facility is not traversable because of a restriction or barrier, so the facility 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 facility is visited. The values for this field are copied from the AdditionalTime field on input facilities.

Double

AdditionalDistance

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

Double

AdditionalCost

The cost added to the total route cost when this facility is visited. The values for this field are copied from the AdditionalCost field on input facilities. 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

Cutoff

The impedance value at which the analysis stopped searching for the facilities from a given incident. The values for this field are copied from the Cutoff field on the input facilities.

Double

ID

A unique identifier for the facility. The values for this field are copied from the ID field on input facilities.

Text

ORIG_FID

FacilityOID

The ObjectID value of the input facility. This field is often used to join information from the input facilities.

OutputFacilities data type include the ORIG_FID field and Facilities data type include the FacilityOID field.

Long

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

Incidents

Provides access to the locations used as starting or ending points in a closest facility analysis.

The data type supports the following fields:

Field

Description

Data Type

Name

The name of the incident. The values for this field are copied from the Name field on input incidents.

Text

TargetFacilityCount

The number of facilities that need to be found for the given incident. The values for this field are copied from the TargetFacilityCount field on input incidents.

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.

Long

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 direction a vehicle may arrive at and depart from the incident. The values for this field are copied from the CurbApproach field on input incidents.

Long

Status

Indicates how the incident was evaluated in the analysis. The possible values are the following:

  • 0 (OK)—The incident was successfully located on the transportation network and analyzed.
  • 1 (Not Located)—The incident was not included in the analysis since a traversable road was not found within the maximum search distance from the incident.
  • 4 (Not Reached)—The incident 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 incident.
  • 7 (Not located on closest)— The closest network location to the incident is not traversable because of a restriction or barrier, so the incident 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

AdditonalTime

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

Double

AdditionalDistance

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

Double

AdditionalCost

The cost added to the total route cost when this incident is visited. The values for this field are copied from the AdditionalCost field on input incidents. 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

Cutoff

The impedance value at which the analysis stopped searching for the incidents from a given facility. The values for this field are copied from the Cutoff field on the input incidents.

Double

IncidentOID

The ObjectID value of the input incident. This field is often used to join information from the input facilities.

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

Routes

Provides access to the resulting route or routes between the facilities and the incidents.

The data types supports the following fields:

Field nameDescriptionData type

Name

The name of the closest facility route is based on the names of the associated facility and incident.

The facility name is first if the value for the travelDirection property on the analysis object is set to TravelDirection.FromFacility. For example, Facility 5 - Incident 3 indicates the route travels from Facility 5 to Incident 3.

If TravelDirection.ToFacility is specified as the value for the travelDirection property, the incident name is first; for instance, Incident 3 — Facility 5.

String

FacilityRank

The rank of the facility among all facilities found for the associated incident; the closest facility has a rank of 1.

Long

FacilityID

The unique ID of the facility the route visits. The values for this field are copied from the ID field on input facilities.

String

FacilityOID

The ObjectID value of the input facility used to generate the route. This field is often used to join information from facilities to routes.

Long

IncidentID

The unique ID of the incident the route visits. The values for this field are copied from the ID field on input incidents .

String

IncidentOID

The ObjectID value of the input incident used to generate the route. This field is often used to join information from incidents to routes.

Long

FacilityCurbApproach

Describes the side of the vehicle the facility is on when arriving at or departing from the facility. A value of 1 means the right side of vehicle; 2 indicates the left side.

Long

IncidentCurbApproach

Describes the side of the vehicle the incident is on when arriving at or departing from the incident. A value of 1 means the right side of the vehicle; a value of 2 indicates the left side.

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 of the route between the facility and the incident. This includes any AdditionalTime if specified for the visited facility and incident.

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 of the route between the facility and the incident. This includes any AdditionalDistance if specified for the visited facility and incident.

Double

Total_Kilometers

The cumulative travel distance in kilometers of the route between the facility and the incident. This includes any AdditionalDistance if specified for the visited facility and incident.

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 of the route between the facility and the incident. This includes any AdditionalCost if specified for the visited facility and incident.

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

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