Skip To Content

LocationAllocation output data types

Describes the output data types containing the results from a location-allocation analysis.

Lines

Provides access to the lines that connect demand points to the facilities to which they are allocated. Such lines are referenced in the documentation as allocation lines. These allocation lines include data about the demand allocated from each demand point to the associated facility.

The data type supports the following fields:

Field

Description

Data type

Name

The name of the allocation line that included the names of the demand point and facility to which the demand point is allocated.

The name of the allocation line is based on the names of the associated facility and demand point.

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 - Demand 3 indicates the route travels from Facility 5 to Demand 3.

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

Text

Weight

The weight assigned from the connected demand point to the connected facility.

Double

FacilityOID

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

Long

DemandOID

The ObjectID value of the corresponding input demand point feature. This field is often used to join information from the demand points to the allocation lines.

Long

Total_Minutes

The travel time in minutes between the facility and the demand point. Note that although the allocation lines have either straight or null geometries, the cost always refers to travel times as measured on a transportation network, not straight-line distances.

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

TotalWeighted_Minutes

The weighted cost of traveling between the facility and the demand point in minutes. This is the Total_Minutes value multiplied by the weight of the demand point allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is time-based.

Note:

An additional field TotalWeigheted_[TimeUnits] is included if the travel mode set for the analysis has an impedance attribute that is time-based and 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

Total_Miles

The travel distance in miles between the facility and the demand point. Note that although the allocation lines have either straight or null geometries, the cost always refers to travel distances as measured on a transportation network, not straight-line distances.

Double

Total_Kilometers

The travel distance in kilometers between the facility and the demand point. Note that although the allocation lines have either straight or null geometries, the cost always refers to travel distances as measured on a transportation network, not straight-line distances.

Note:

An additional field Total_[DistanceUnits] is included if the distanceUnits property of the analysis object is not set to DistanceUnits.Kilometers or DistanceUnits.Miles. The field values are in the units specified by the distanceUnits property.

Note:

Additional fieldsTotal_[AccumulateAttributeName]_[DistanceUnits] are included for each time-based cost attribute that is accumulated during the analysis.

Double

TotalWeighted_Miles

The weighted cost of traveling between the facility and the demand point in miles. This is the Total_Miles value multiplied by the weight of the demand point allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is distance-based.

Double

TotalWeighted_Kilometers

The weighted cost of traveling between the facility and the demand point in kilometers. This is the Total_Kilometers value multiplied by the weight of the demand point allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is distance-based.

Note:

An additional field TotalWeigheted_[DistanceUnits] is included if the travel mode set for the analysis has an impedance attribute that is distance-based and 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

Total_Other

The travel cost in unknown units between the facility and the demand point. Note that although the allocation lines have either straight or null geometries, the cost always refers to travel cost as measured on a transportation network, not straight-line distances.

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

TotalWeighted_Other

The weighted cost of traveling between the facility and the demand point in unknown units. This is the Total_Cost value multiplied by the weight of the demand point allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is neither time-based or distance-based.

Double

Facilities

Provides access to the chosen, required, and competitor facilities, as well as any candidate facilities that were not chosen.

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

Field

Description

Data type

Name

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

String

FacilityOID

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

Double

FacilityType

The best facilities, or those that are chosen in the analysis, are indicated in this field. All facility types are as follows:

  • 0 (Candidate)—The service didn't choose the candidate facility to be part of the solution.
  • 1 (Required)—Prior to submitting the analysis, the facility was designated as "required"; therefore, it is part of the solution regardless of how much demand it was able to capture.
  • 2 (Competitor)—The facility represents your rivals and will remove demand from the problem. Competitor facilities are specific to the Maximize Market Share and Target Market Share problem types; they are ignored in other problem types.
  • 3 (Chosen)—These are the chosen facilities; that is, candidate facilities that capture the most demand.

Long

Weight

The relative weighting of the facility, which is used to rate the attractiveness, desirability, or bias of one facility compared to another. The values for this field are copied from the Weight field on input facilities.

Double

Capacity

The amount of weighted demand the facility is capable of supplying. The values for this field are copied from the Capacity field on input facilities.

Double

DemandCount

A count of demand points allocated to the facility. A nonzero value means the facility was part of the solution, either as a required, competitor, or chosen facility.

Long

DemandWeight

The sum of the effective weight from all demand points that were allocated to the facility. The value is the sum of all the Weight values from the demand points that were allocated to the facility. In the case of the Maximize Attendance and Market Share Problem types, the value is an apportioned sum of the Weight field values, since these problem types allow demand to decay with distance or be split among many facilities.

Double

Total_Minutes

A sum of travel time in minutes between the facility and each of the demand points that were allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is time-based.

Note:

An additional field Total_[TimeUnits] is included if the travel mode set for the analysis has an impedance attribute that is time-based and 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

TotalWeighted_Minutes

This field stores the cumulative weighted cost in minutes for a facility. The weighted cost for a demand point is its weight multiplied by the least-cost path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility.

For example, if a demand point with a weight of two is allocated to a facility 10 minutes away, the TotalWeighted_Minutes value is 20 (2 x 10). If another demand point with a weight of three is allocated to the same facility and is 5 minutes away, the TotalWeighted_Minutes value increases to 35 (3 x 5 + 20)

This field is included only if the travel mode set for the analysis has an impedance attribute that is time-based.

Note:

An additional field TotalWeighted_[TimeUnits] is included if the travel mode set for the analysis has an impedance attribute that is time-based and 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

Total_Miles

A sum of travel distance in miles between the facility and each of the demand points that were allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is distance-based.

Note:

An additional field Total_[DistanceUnits] is included if the travel mode set for the analysis has an impedance attribute that is distance-based and 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

TotalWeighted_Miles

This field stores the cumulative weighted cost in miles for a facility. The weighted cost for a demand point is its weight multiplied by the least-cost path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility.

For example, if a demand point with a weight of two is allocated to a facility 10 miles away, the TotalWeighted_Miles value is 20 (2 x 10). If another demand point with a weight of three is allocated to the same facility and is 5 miles away, the TotalWeighted_Miles value increases to 35 (3 x 5 + 20)

This field is included only if the travel mode set for the analysis has an impedance attribute that is distance-based.

Note:

An additional field TotalWeighted_[DistanceUnits] is included if the travel mode set for the analysis has an impedance attribute that is distance-based and 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

Total_Kilometers

This field is analogous to Total_Miles field except values are in kilometers instead of miles.

Double

TotalWeighted_Kilometers

This field is analogous to TotalWeighted_Miles field except values are in kilometers instead of miles.

Double

Total_Other

A sum of travel cost in unknown units between the facility and each of the demand points that were allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is neither time-based or distance-based.

Double

TotalWeighted_Other

This field stores the cumulative weighted cost in unknown units for a facility. The weighted cost for a demand point is its weight multiplied by the least-cost path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility.

This field is included only if the travel mode set for the analysis has an impedance attribute that is neither time-based or distance-based.

Double

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 depart from or arrive at 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

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

DemandPoints

Provides access to the demand points that participated in the analysis: those that were and were not allocated to facilities.

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

Field

Description

Data type

Name

The name of the demand point. The values for this field are copied from the Name field on input demand points.

Text

FacilityOID

The ObjectID value of the facility to which this demand point is allocated to. The field value is Null if the demand point is not allocated to any facility. This field is often used to join information from the input facilities to the output demand points.

Long

DemandOID

The ObjectID value of the corresponding input demand point feature. This field is often used to join information.

Long

Weight

The relative weighting of the demand point. The values for this field are copied from the Weight field on input demand points.

Double

AllocatedWeight

The amount of demand allocated to chosen and required facilities. The value excludes demand allocated to competing facilities. The value can have three interpretations:

  • Null—The demand point wasn't assigned to any facility. This can result, for example, if the demand point could not be reached from any facility.
  • 0—The demand point was only assigned to competing facilities.
  • Positive, nonzero value—Indicates how much demand is assigned to your chosen and required facilities.

Double

GroupName

The name of the group of which the demand point is a part of. The values for this field are copied from the GroupName field on input demand points.

String

ImpedanceTransformation

The values for this field are copied from the ImpedanceTransformation field on input demand points.

Long

ImpedancParameter

The values for this field are copied from the ImpedanceParameter field on input demand points.

Double

Cutoff

The demand point can't be allocated to a facility that is beyond the value indicated here. The values for this field are copied from the Cutoff field on input demand points.

Double

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 depart from or arrive at the demand point. The values for this field are copied from the CurbApproach field on input facilities.

Long

Status

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

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

Bearing

The values for this field are copied from the Bearing field on the input demand points.

Double

BearingTol

The values for this field are copied from the BearingTol field on the input demand points.

Double

NavLatency

The values for this field are copied from the NavLatency field on the input demand points.

Double