Summary
Allows the setup of capacity constraints at a specified level.
Usage
The Territory Level format must be as follows: Level_Name[Level_Index]
Capacity Variables are an optional parameter. The pound sign, "#", can be specified when removing capacity variables from the specified level.
- Capacity variables can be specified in the following format: Variable {Minimum} {Desired} {Maximum} Preference;...
- Variable – name of any Summary-type field from the Alignment Layer of the specified solution. Non-BDS layer variables will have a "_SUM" suffix (SUM calculator applied).
- Minimum, Desired and Maximum are optional parameters. The pound sign "#", can be specified instead for any of them but at least one value must be specified.
- Minimum Capacity – the territory must have at least this specified variable value. The CreateTerritories command will automatically exclude areas which have values less than what is specified.
- Desired Capacity – the territory builds until the specified variable value has been reached. The available range for this parameter is from Minimum Capacity to Maximum Capacity.
- Maximum Capacity – the territory must stop building before the specified variable value has been exceeded. The Maximum Capacity must be greater than the Minimum Capacity.
- The preference must be specified for each variable. A valid range is from 0 to 100. The total sum of all preferences must equal 100.
Syntax
SetupCapacityConstraints_TD_td (in_territory_solution_layer, in_level, {in_capacity_variables})| Parameter | Explanation | Data Type |
in_territory_solution_layer | The Territory Solution layer used to setup the parameters. | GP TD Layer |
in_level | The Territory Level to modify. | String |
in_capacity_variables [in_capacity_variables,...] (Optional) | The Capacity variables and preferences. | GP Value Table |
Code Sample
SetupCapacityConstraints_TD example (Python window)
The following Python window script demonstrates how to use the tool in immediate mode.
import arcgisscripting
gp = arcgisscripting.create()
gp.SetupLevelCapacityConstraints_TD("new layer", "Territories[1]", "AREA_SUM 10000 # # 45;TOTPOP_CY_SUM # 3000000 5000000 55")
SetupCapacityConstraints_TD example 2 (stand-alone script)
lThe following stand-alone script demonstrates how to use the tool.
# Import system modules
import arcgisscripting
gp = arcgisscripting.create()
# Set local variables
solution = "new layer"
level = "Territories[1]"
capacityVars = "AREA_SUM 10000 # # 45;TOTPOP_CY_SUM # 3000000 5000000 55"
# Execute tool
gp.SetupLevelCapacityConstraints_TD(solution, level, capacityVars)
Environments
This tool does not use any geoprocessing environments
Licensing Information
- ArcGIS for Desktop Basic: Requires Business Analyst
- ArcGIS for Desktop Standard: Requires Business Analyst
- ArcGIS for Desktop Advanced: Requires Business Analyst