Describes the output data types containing the results from a closest facility analysis.
ClosestFacilities and Facilities
This provides access to the output facilities from a closest facility analysis.
The ClosestFacilities data type includes only those facilities from the set of input facilities that were closest to at least one incident. The 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 support 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 name | Description | Data type |
---|---|---|
Name | The name of the facility. The values for this field are copied from the Name field on the input facilities. | Text |
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 facility. The values for this field are copied from the CurbApproach field on the input facilities. | Long |
Status | Indicates 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:
| 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 facility is visited. The values for this field are copied from the AdditionalTime field on the 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 the 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 the input facilities. 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 |
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 the 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. The ClosestFacilities output includes the ORIG_FID field, and the Facilities output includes 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
This provides access to the locations used as starting or ending points in a closest facility analysis.
The data type supports the following fields:
Field name | 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 the input incident. | Integer |
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. | Long |
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 incident. The values for this field are copied from the CurbApproach field on the input incident. | Long |
Status | Indicates 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:
| 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 |
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 the 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 the input incident. | 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 the input incident. 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 |
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 incident. | 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
This provides access to the resulting route or routes between the facilities and the incidents.
The data types supports the following fields:
Field name | Description | Data 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 the 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; a value of 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 for the visited facility and incident 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 of the route between the facility and the incident. This includes any AdditionalDistance for the visited facility and incident if specified. | Double |
Total_Kilometers | The cumulative travel distance in kilometers of the route between the facility and the incident. This includes any AdditionalDistance for the visited facility and incident 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 of the route between the facility and the incident. This includes any AdditionalCost for the visited facility and incident 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 |
Directions
This provides access to the turn-by-turn directions for each resulting route.
The data type supports the following fields:
Field name | 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, check the value of the SubItemType field. 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 your application. The Type value is an integer from the Maneuver Types or Directions String Types lists below. Maneuver Types
Directions String Types
| Short |
SubItemType | Specifies whether the Type field refers to an integer from the Directions String Types table or the Maneuver 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. | 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 |
DirectionPoints
Specifies the output turn-by-turn directions for the routes calculated in the analysis, represented as point locations along the routes where specific directions events or maneuvers occur.
Field name | Description | Data type |
---|---|---|
RouteID | The ObjectID of the output Routes feature with which this direction point is associated. | Integer |
Sequence | The sequence of the direction points for the route, starting with 1. | Integer |
DirectionPointType | The type of directions event or maneuver described by the point, designated by one of the values below.
| Integer |
FacilityID | The ObjectID of the facility with which this direction point is associated, if any. If the point does not represent a visit to a facility, the value is null. | Integer |
IncidentID | The ObjectID of the incident with which this direction point is associated, if any. If the point does not represent a visit to an incident, the value is null. | Integer |
DisplayText | The directions text to display in the consuming application. | String |
ArrivalTime | The time when the directions event happens 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, in minutes. | Double |
Name | The name of the directions point. | String |
ExitName | The highway exit name that appears in the directions instruction. | String |
AlternateName | Alternate source name that appears in the directions instruction. | String |
IntersectingName | The name of the intersecting or cross street that appears in the directions instruction. | String |
BranchName | The signpost branch name that appears in the directions instruction. | String |
TowardName | The signpost toward destination name that appears in the directions instruction. | String |
Level | The building level at which this directions event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis. | Integer |
ShortVoiceInstruction | Short text to use as voice guidance text in the consuming application. | String |
VoiceInstruction | Fill text, including expanded abbreviations and plurals, to use as voice guidance text in the consuming application. | String |
Azimuth | The bearing in degrees of the vehicle departing this point. Zero indicates north. | Double |
DirectionLines
Specifies the output route lines calculated in the analysis sliced to represent each route segment between DirectionPoints event or maneuver locations.
Field name | Description | Data type |
---|---|---|
DirectionPointID | The ObjectID of the feature in the DirectionPoints table with which this line is associated. | Integer |
RouteID | The ObjectID of the output Routes feature with which this direction line is associated. | Integer |
DirectionLineType | The type of directions situation described by this line, designated by one of the values below.
| Integer |
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 directions 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 | Integer |
ToLevel | The building level at which this directions event ends. This value corresponds to the Level property defined in the network dataset used for the analysis. | Integer |