/SolveLocationAllocation

Attributes for facilities

• Namestring (length: 500)nullable

  The name of the facility. The name is included in the name of output allocation lines if the facility is part of the solution.

• FacilityTypeint enumdefault:0

  Allowed values: 0, 1, 2

  Specify whether the facility is a candidate, required, or a competitor facility. The field value is specified as one of the following integers:

  • 0:Candidate—A facility that may be part of the solution.
  • 1:Required—A facility that must be part of the solution.
  • 2:Competitor—A rival facility that potentially removes demand from your facilities. Competitor facilities are specific to the maximize market share and target market share problem types; they are ignored in other problem types.

• Weightnumber (non-negative)

  The relative weighting of the facility, which is used to rate the attractiveness, desirability, or bias of one facility compared to another.

  For example, a value of 2.0 could capture the preference of customers who prefer, at a ratio of 2 to 1, shopping in one facility over another facility. Factors that potentially affect facility weight include square footage, neighborhood, and age of the building. Weight values other than one are only honored by the maximize market share and target market share problem types; they are ignored in other problem types.

• Cutoffnumber (non-negative)default:0

  The impedance value at which to stop searching for demand points from a given facility. The demand point can't be allocated to a facility that is beyond the value indicated here.

  This attribute allows you to specify a different cutoff value for each demand point. For example, You might find that people in rural areas are willing to travel up to 10 miles to reach a facility, while urbanites are only willing to travel up to 2 miles. You can model this behavior by setting the Cutoff value for all demand points that are in rural areas to 10 and setting the Cutoff value of the demand points in urban areas to 2.

• Capacitynumber (non-negative)default:0

  The Capacity field is specific to the Maximize Capacitated Coverage problem type; the other problem types ignore this field.

  Capacity specifies how much weighted demand the facility is capable of supplying. Excess demand won't be allocated to a facility even if that demand is within the facility's default measurement cutoff.

  Any value assigned to the Capacity field overrides the Default Capacity parameter (Default_Capacity in Python) for the given facility.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specifies the direction a vehicle may arrive at and depart from the facility. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The vehicle can approach and depart the facility in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the order or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the facility, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the facility, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle approaches the facility, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around. Learn more about U-turn policies
  Show illustration

  Setting	Coded value	Description
  Either side of vehicle	0	The vehicle can approach and depart the facility in either direction, so a U-turn is allowed at the facility. This setting can be chosen if it is possible and desirable for a vehicle to turn around at the facility. This decision may depend on the width of the road and the amount of traffic or whether the location has a parking lot where vehicles can pull in and turn around. All arrival and departure combinations are allowed with the Either side of vehicle curb approach.
  Right side of vehicle	1	When the vehicle approaches and departs the facility, the facility must be on the right side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination for the Right side of vehicle curb approach is shown.
  Left side of vehicle	2	When the vehicle approaches and departs the facility, the facility must be on the left side of the vehicle. A U-turn is prohibited. This is typically used for vehicles such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach is shown.
  No U-Turn	3	When the vehicle approaches the facility, the facility can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived. A U-turn is prohibited. The allowed arrival and departure combinations for the No U-Turn curb approach are shown.

  The CurbApproach attribute is designed to work with both types of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider an facility on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach an facility from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at an facility and not have a lane of traffic between the vehicle and the facility, choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencynumber (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Attributes for demand points

• Namestring (length: 500)nullable

  The name of the demand point. The name is included in the name of an output allocation line or lines if the demand point is part of the solution.

• GroupNamestring (length: 500)

  The name of the group to which the demand point belongs. This field is ignored for the Maximize Capacitated Coverage, Target Market Share, and Maximize Market Share problem types.

  If demand points share a group name, the solver allocates all members of the group to the same facility. (If constraints, such as a cutoff distance, prevent any of the demand points in the group from reaching the same facility, none of the demand points are allocated.)

  

  Minimize distance without grouped demand points.

  

  Minimize distance with grouped demand points. In this example, the yellow demand points have the same GroupName value, so they are allocated to the same facility.

• Weightnumber (non-negative)

  The relative weighting of the demand point. A value of 2.0 means the demand point is twice as important as one with a weight of 1.0. If demand points represent households, for example, weight could indicate the number of people in each household.

• Cutoffnumber (non-negative)default:0

  The impedance value at which to stop searching for demand points from a given facility. The demand point can't be allocated to a facility that is beyond the value indicated here.

  This attribute allows you to specify a cutoff value for each demand point. For example, you may find that people in rural areas are willing to travel up to 10 miles to reach a facility, while those in urban areas are only willing to travel up to 2 miles. You can model this behavior by setting the Cutoff value for all demand points that are in rural areas to 10 and setting the Cutoff value of the demand points in urban areas to 2.

  The units for this attribute value are specified by the measurement_units parameter.

  A value for this attribute overrides the default set for the analysis using the default_measurement_cutoff parameter. The default value is Null, which results in the default value set by the default_measurement_cutoff parameter being used for all the demand points.

• ImpedanceTransformationinteger

  Override the default value set for the analysis by the measurement_transformation_model parameter.

• ImpedanceParameternumber (non-negative)

  Override the default value set for the analysis by the measurement_transformation_model parameter.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2, 3

  Specifies the direction a vehicle may arrive at or depart from the demand point. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The vehicle can approach and depart the demand point in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the order or if it can pull into a driveway or parking lot and turn around.
  • 1: Right side of vehicle. When the vehicle approaches and departs the demand point, the curb must be on the right side of the vehicle. A U-turn is prohibited.
  • 2: Left side of vehicle. When the vehicle approaches and departs the demand point, the curb must be on the left side of the vehicle. A U-turn is prohibited.
  • 3: No U-turn. When the vehicle approaches the demand point, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around. Learn more about U-turn policies
  Show illustration

  Setting	Coded value	Description
  Either side of vehicle	0	The vehicle can approach and depart the demand point in either direction. All arrival and departure combinations are allowed with the Either side of vehicle curb approach.
  Right side of vehicle	1	When the vehicle approaches or departs the demand point, the demand point must be on the right side of the vehicle. This is typically used for vehicles such as buses that must arrive with the bus stop on the right side. The allowed arrival and departure combination for the Right side of vehicle curb approach is shown.
  Left side of vehicle	2	When the vehicle approaches or departs the demand point, the demand point must be on the left side of the vehicle. This is typically used for vehicles such as buses that must arrive with the bus stop on the left side. The allowed arrival and departure combination for the Left side of vehicle curb approach is shown.
  No U-Turn	3	When the vehicle approaches the demand point, the demand point can be on either side of the vehicle; however, when it departs, the vehicle must continue in the same direction it arrived in. A U-turn is prohibited. The allowed arrival and departure combinations for the No U-Turn curb approach are shown.

  The CurbApproach property is designed to work with both types of national driving standards: right-hand traffic (United States) and left-hand traffic (United Kingdom). First, consider a demand point on the left side of a vehicle. It is always on the left side regardless of whether the vehicle travels on the left or right half of the road. What may change with national driving standards is your decision to approach a demand point from one of two directions, that is, so it ends up on the right or left side of the vehicle. For example, if you want to arrive at a demand point and not have a lane of traffic between the vehicle and the demand point, you would choose 1 (Right side of vehicle) in the United States and 2 (Left side of vehicle) in the United Kingdom.

  

  

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencynumber (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

Example for locate_settings

Example 1: Specify locate settings using a JSON structure

This example shows how to specify locate settings so inputs are only located within 500 meters of the specified location. A small search tolerance like this can be helpful if you are solving using a walking travel mode and don't want inputs to be located farther than 500 meters from the original point location.

1
2
3
4
5
6
7
8
9
10
11
12
{
  "default": {
    "tolerance": 500,
    "toleranceUnits": "esriMeters",
    "allowAutoRelocate": true,
    "sources": [
      {
        "name": "Routing_Streets"
      }
    ]
  }
}

The next set of graphics and tables use Minimize Impedance to demonstrate the potential effects of using different impedance transformations and parameters.

A sample problem setup using two-mile edges with demand points on the ends and candidate facilities in the middle of the edges is shown.

The Linear transformation always uses a parameter value of one, so the cost is unchanged, and facility B minimizes that cost.

Comparison of costs using a linear transformation

Facility B has a lower total transformed cost than facility A when a linear transformation is used.

A Power transformation with a parameter of two amplifies longer distances enough that facility A minimizes cost instead.

Comparison of costs using a power transformation with a parameter of 2.0

Facility A has a lower total transformed cost than facility B when a squared power transformation is used.

An exponential transformation with an impedance parameter of 0.02 favors nearby demand points, so facility B is the solution facility in this case. (The graphic is omitted, since it would look the same as the linear transformation graphic.)

Comparison of costs using an exponential transformation with a parameter of 0.02

This parameter can have the following values:

Parameter Value	Description
Allowed	U-turns are permitted everywhere. Permitting U-turns implies that the vehicle can turn around at a junction and double back on the same street. U-turns are permitted at junctions with any number of adjacent streets.
Allowed only at Intersections and Dead Ends	U-turns are prohibited at junctions where exactly two adjacent streets meet. U-turns are permitted only at intersections or dead ends.
Allowed only at Dead Ends	U-turns are prohibited at all junctions and intersections and are permitted only at dead ends. U-turns are permitted only at dead ends.
Not Allowed	U-turns are prohibited at all junctions, intersections, and dead-ends. Even when this parameter value is chosen, a route can still make U-turns at stops. To prohibit U-turns at a stop, you can set its CurbApproach property to the appropriate value (3).

Attributes for point_barriers

• Namestringnullable

  The name of the barrier.

• CurbApproachint enumdefault:0

  Allowed values: 0, 1, 2

  Specify the direction of traffic that is affected by the barrier. The field value is specified as one of the following integers:

  • 0: Either side of vehicle. The barrier affects travel over the edge in both directions.
  • 1: Right side of vehicle. Vehicles are only affected if the barrier is on their right side during the approach. Vehicles that traverse the same edge but approach the barrier on their left side are not affected by the barrier.
  • 2: Vehicles are only affected if the barrier is on their left side during the approach. Vehicles that traverse the same edge but approach the barrier on their right side are not affected by the barrier.

  Because junctions are points and don't have a side, barriers on junctions affect all vehicles regardless of the curb approach.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 2

  Specify whether the point barrier restricts travel completely or adds time or distance when it is crossed.

  The value for this attribute is specified as one of the following integers:

  • 0: Restriction. Prohibits travel through the barrier. The barrier is referred to as a restriction point barrier since it acts as a restriction.

    

    The first map shows the shortest path between two stops without any restriction point barriers. The second map has a road that is blocked by a fallen tree, so the shortest path between the same points is longer.

  • 2: Added Cost. Traveling through the barrier increases the travel time or distance by the amount specified in the Additional_Time, Additional_Distance, or AdditionalCost attribute. This barrier type is referred to as an added cost point barrier.
  

  The map on the left shows the shortest path between two stops without any added cost point barrier. For the map on the right, the travel time from stop one to stop two would be the same whether going around the north end of the block or the south end; however, since crossing railroad tracks incurs a time penalty (modeled with added cost point barriers), the route with only one railroad crossing is chosen. The cost of crossing the barrier is added to the accumulated travel time of the resulting route.

• FullEdgeint enumdefault:0

  Allowed values: 0, 1

  Specify how the restriction point barriers are applied to the edge elements during the analysis

  • 0:False—Permits travel on the edge up to the barrier but not through it.
  • 1:True—Restricts travel anywhere on the associated edge.

• Additional_Timenumber (non-negative)default:0

  The added travel time when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the measurement_units parameter.

• Additional_Distancenumber (non-negative)default:0

  The added distance when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero, and its units are the same as those specified in the measurement_units parameter.

• AdditionalCostnumber (non-negative)default:0

  The added cost when the barrier is traversed. This attribute is applicable only for added-cost barriers. The attribute value must be greater than or equal to zero.

• Bearingnumber (non-negative)nullable

  The direction in which a point is moving. The units are degrees and are measured clockwise from true north.

  This attribute is used in conjunction with the BearingTol attribute. Bearing data is usually sent automatically from a mobile device equipped with a GPS receiver. Try to include bearing data if you are loading an input location that is moving, such as a pedestrian or a vehicle. Using this attribute tends to prevent adding locations to the wrong edges, which can occur when a vehicle is near an intersection or an overpass, for example. Bearing also helps the solver determine the side of the street that the point is on.

  Learn more about bearing and bearing tolerance

• BearingTolnumber (range: 0 - 180)default:30nullable

  The bearing tolerance value creates a range of acceptable bearing values when locating moving points on an edge using the Bearing attribute.

  If the Bearing attribute value is within the range of acceptable values that are generated from the bearing tolerance on an edge, the point can be added as a network location there; otherwise, the closest point on the next-nearest edge is evaluated. The units are in degrees. A value of 30 means that when Network Analyst attempts to add a network location on an edge, a range of acceptable bearing values is generated 15 degrees to either side of the edge (left and right) and in both digitized directions of the edge.

  Learn more about bearing and bearing tolerance

• NavLatencynumber (non-negative)nullable

  Indicates how much cost is expected to elapse from the moment GPS information is sent from a moving vehicle to a server and the moment the processed route is received by the vehicle's navigation device.

  This attribute is only used in the solve process if the Bearing and BearingTol fields also have values; however, providing a NavLatency attribute value is optional, even when values are present in the Bearing and BearingTol.

This example shows how to use an added cost point barrier to model a five-minute delay at a railroad crossing. The BarrierType attribute is used to specify that the point barrier is of type added cost and the Attr_TravelTime attribute is used to specify the delay in minutes.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "x": 37.541479,
        "y": -122.053461
      },
      "attributes": {
        "Name": "Haley St railroad crossing",
        "BarrierType": 2,
        "Additional_Time": 5
      }
    }
  ]
}

Attributes for line_barriers

• Namestring (length: 500)nullable

  The name of the barrier.

This example shows how to add two lines as polyline barriers to restrict travel on the streets intersected by the lines. Barrier 1 is a single-part line feature composed of two points. Barrier 2 is a two-part line feature. The first part is composed of three points, and the second part is composed of two points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "spatialReference": {
    "wkid": 102100
  },
  "features": [
    {
      "geometry": {
        "paths": [
          [
            [-10804823.397, 3873688.372],
            [-10804811.152, 3873025.945]
          ]
        ]
      },
      "attributes": {
        "Name": "Barrier 1"
      }
    },
    {
      "geometry": {

Attributes for polygon_barriers

• Namestringnullable

  The name of the barrier.

• BarrierTypeint enumdefault:0

  Allowed values: 0, 1

  Specify polygons that either completely restrict travel or proportionately scale the time or distance required to travel on the streets intersected by the polygons.

  The value for this attribute can be specified as one of the following integers:

  • 0: Restriction. Prohibits traveling through any part of the barrier. The barrier is referred to as a restriction polygon barrier since it prohibits traveling on streets intersected by the barrier. One use of this type of barrier is to model floods covering areas of the street that make traveling on those streets impossible.

    

    The first map depicts the shortest path between two stops. The second map shows a polygon barrier blocking flooded streets, so the shortest path between the same two stops is different.

  • 1: Scaled Cost. Scales the cost (such as travel time or distance) required to travel the underlying streets by a factor specified using the ScaledTimeFactor or ScaledDistanceFactor attribute.

    If the streets are partially covered by the barrier, the travel time or distance is apportioned and then scaled. For example, a factor of 0.25 means that travel on underlying streets is expected to be four times faster than normal. A factor of 3.0 means it is expected to take three times longer than normal to travel on underlying streets. This barrier type is referred to as a scaled-cost polygon barrier. It can be used to model storms that reduce travel speeds in specific regions, for example.

  

  The first map shows a route that goes through inclement weather without regard for the effect that poor road conditions have on travel time. The second map shows a scaled polygon barrier that doubles the travel time of the roads covered by the storm. The route still passes through the southern tip of the storm since it is quicker to spend more time driving slowly through a small part of the storm rather than driving completely around it. The service uses the modified travel time in calculating the best route, and the modified travel time is reported as the total travel time in the response.

• ScaledTimeFactornumber (non-negative)default:1

  This is the factor by which the travel time of the streets intersected by the barrier is multiplied. The field value must be greater than zero.

  This field is applicable only for scaled-cost barriers and when the measurement_units parameter is time-based.

• ScaledDistanceFactornumber (non-negative)default:1

  This is the factor by which the distance of the streets intersected by the barrier is multiplied. The field value must be greater than zero.

  This field is applicable only for scaled-cost barriers and when the measurement_units parameter is distance-based.

• ScaledCostFactornumber (non-negative)default:1

  The scaled cost when the barrier is traversed. This attribute is applicable only for scaled-cost barriers. The attribute value must be greater than or equal to zero.

  This field is applicable only for scaled-cost barriers when the impedance is neither time-based nor distance-based.

This example shows how to add two polygons as barriers. The first polygon, Flood zone, is a restriction polygon barrier that prohibits travel on the underlying streets. The polygon is a single-part polygon feature composed of four points. The second polygon, Severe weather zone, is a scaled-cost polygon barrier that reduces the travel time on underlying streets to one-third of the original value. The polygon is a two-part polygon feature. Both parts are composed of four points.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "spatialReference": {
    "wkid": 4326
  },
  "features": [
    {
      "geometry": {
        "rings": [
          [
            [-97.0634, 32.8442],
            [-97.0554, 32.84],
            [-97.0558, 32.8327],
            [-97.0638, 32.83],
            [-97.0634, 32.8442]
          ]
        ]
      },
      "attributes": {
        "Name": "Flood zone",
        "BarrierType": 0

• Namestring (length: 500)nullable

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

• FacilityOIDintegernullable

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

• FacilityTypeint enumnullable

  The best facilities, or those that are chosen in the analysis, are indicated in this field. The 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 captured.
  • 2:Competitor—The facility represents the 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, they are candidate facilities that capture the most demand.

• Weightintegernullable

  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 the input facilities.

• Capacityintegernullable

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

• DemandCountintegernullable

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

• DemandWeightintegernullable

  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.

• Total_Minutesintegernullable

  The 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.

• TotalWeighted_Minutesnumbernullable

  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 2 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 3 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.

• Total_Milesnumbernullable

  The 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.

• TotalWeighted_Milesnumbernullable

  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 2 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 3 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.

• Total_Kilometersnumbernullable

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

• TotalWeighted_Kilometersnumbernullable

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

• Total_Othernumbernullable

  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 nor distance based.

• TotalWeighted_Othernumbernullable

  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 nor distance based.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDinteger (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongnumber (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• Statusint enum

  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as 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 cannot 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 cannot 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. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)

• Bearingnumber (non-negative)nullable

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

• BearingTolnumber (non-negative)nullable

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

• NavLatencynumber (non-negative)nullable

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

• Namestring (length: 500)nullable

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

• FacilityOIDintegernullable

  The ObjectIDvalue of the facility to which this demand point is allocated. 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.

• DemandOIDintegernullable

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

• Weightintegernullable

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

• AllocatedWeightintegernullable

  The amount of demand allocated to chosen and required facilities. The value excludes demand allocated to competing facilities. The value options are as follows:

  • 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 the chosen and required facilities.

• GroupNamestring (length: 500)nullable

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

• ImpedanceTransformationintegernullable

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

• ImpedanceParameternumbernullable

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

• Cutoffnumbernullable

  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 the input demand points.

• SourceIDinteger (non-negative)nullable

  The numeric identifier of the network dataset source feature class on which the input point is located.

• SourceOIDinteger (non-negative)nullable

  The object ID of the feature in the source on which the input point is located.

• PosAlongnumber (non-negative)nullable

  The position along the digitized direction of the source line feature. This value is stored as a ratio. This attribute is null if the network location references a junction.

• SideOfEdgeint enum

  Allowed values: 1, 2

  The side of the edge in relation to the digitized direction of the line feature.

  This attribute is limited to a domain of two values:

  • 1: Right Side
  • 2: Left Side

• Statusint enum

  Allowed values: 0, 1, 2, 3, 4, 5, 6, 7

  Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are as 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 cannot 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 cannot 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. If time windows are used and the route arrives early or late, the value changes to 6 (Time window violation)

• Bearingnumber (non-negative)nullable

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

• BearingTolnumber (non-negative)nullable

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

• NavLatencynumber (non-negative)nullable

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

• Namestring (length: 500)nullable

  The name of the allocation line that includes 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 travel_direction parameter value is set to Facility To Demand. For example, Facility 5 - Demand 3 indicates that the route travels from Facility 5 to Demand 3.

  If Demand To Facility is specified as the travel_direction parameter value, the demand point name is first, for example, Demand 3 — Facility 5 .

• FacilityOIDintegernullable

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

• DemandOIDintegernullable

  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.

• Weightintegernullable

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

• Total_Minutesintegernullable

  The travel time in minutes between the facility and the demand point. 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.

• TotalWeighted_Minutesnumbernullable

  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.

• Total_Milesnumbernullable

  The travel distance in miles between the facility and the demand point. 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.

• Total_Kilometersnumbernullable

  The travel distance in kilometers between the facility and the demand point. 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.

• TotalWeighted_Milesnumbernullable

  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.

• TotalWeighted_Kilometersnumbernullable

  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.

• Total_Othernumbernullable

  The travel cost in unknown units between the facility and the demand point. 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 nor distance-based.

• TotalWeighted_Othernumbernullable

  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 nor distance-based.