com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class MakeLocationAllocationLayer
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.networkanalysttools.MakeLocationAllocationLayer
- All Implemented Interfaces:
- GPTool
public class MakeLocationAllocationLayer
- extends AbstractGPTool
Makes a location-allocation network analysis layer and sets its analysis properties. A location-allocation analysis layer is useful for choosing a given number of facilities from a set of potential locations such that a demand will be allocated to facilities in an optimal and efficient manner.
The Make Location-Allocation Layer tool is contained in the Network Analyst Tools tool box.
Usage tips:
- After creating the analysis layer with this tool, you can add network analysis objects to it using the tool, solve the analysis using the tool, and save the results on disk using tool.
- When using this tool in geoprocessing models, if the model is run as a tool, the output network analysis layer must be made a model parameter. Otherwise the output layer is not added to the table of contents in ArcMap.
Constructor Summary |
MakeLocationAllocationLayer()
Creates the Make Location-Allocation Layer tool with defaults. |
MakeLocationAllocationLayer(java.lang.Object inNetworkDataset,
java.lang.String outNetworkAnalysisLayer,
java.lang.String impedanceAttribute)
Creates the Make Location-Allocation Layer tool with the required parameters. |
Method Summary |
java.lang.Object |
getAccumulateAttributeName()
Returns the Accumulators parameter of this tool . |
java.lang.String |
getHierarchy()
Returns the Use hierarchy in analysis parameter of this tool . |
java.lang.String |
getImpedanceAttribute()
Returns the Impedance attribute parameter of this tool . |
double |
getImpedanceCutoff()
Returns the Impedance cutoff parameter of this tool . |
double |
getImpedanceParameter()
Returns the Impedance parameter parameter of this tool . |
java.lang.String |
getImpedanceTransformation()
Returns the Impedance transformation parameter of this tool . |
java.lang.Object |
getInNetworkDataset()
Returns the Input analysis network parameter of this tool . |
java.lang.String |
getLocAllocFromTo()
Returns the Travel from parameter of this tool . |
java.lang.String |
getLocAllocProblemType()
Returns the Location-allocation problem type parameter of this tool . |
int |
getNumberFacilitiesToFind()
Returns the Number of facilities to find parameter of this tool . |
java.lang.String |
getOutNetworkAnalysisLayer()
Returns the Output layer name parameter of this tool . |
java.lang.Object |
getOutputLayer()
Returns the Network Analyst Layer parameter of this tool (Read only). |
java.lang.String |
getOutputPathShape()
Returns the Output path shape parameter of this tool . |
java.lang.Object |
getRestrictionAttributeName()
Returns the Restrictions parameter of this tool . |
double |
getTargetMarketShare()
Returns the Target market share parameter of this tool . |
java.lang.String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
java.lang.String |
getToolboxName()
Returns the name of the tool box containing this tool. |
java.lang.String |
getToolName()
Returns the name of this tool. |
java.lang.String |
getUTurnPolicy()
Returns the U-turn policy parameter of this tool . |
void |
setAccumulateAttributeName(java.lang.Object accumulateAttributeName)
Sets the Accumulators parameter of this tool . |
void |
setHierarchy(java.lang.String hierarchy)
Sets the Use hierarchy in analysis parameter of this tool . |
void |
setImpedanceAttribute(java.lang.String impedanceAttribute)
Sets the Impedance attribute parameter of this tool . |
void |
setImpedanceCutoff(double impedanceCutoff)
Sets the Impedance cutoff parameter of this tool . |
void |
setImpedanceParameter(double impedanceParameter)
Sets the Impedance parameter parameter of this tool . |
void |
setImpedanceTransformation(java.lang.String impedanceTransformation)
Sets the Impedance transformation parameter of this tool . |
void |
setInNetworkDataset(java.lang.Object inNetworkDataset)
Sets the Input analysis network parameter of this tool . |
void |
setLocAllocFromTo(java.lang.String locAllocFromTo)
Sets the Travel from parameter of this tool . |
void |
setLocAllocProblemType(java.lang.String locAllocProblemType)
Sets the Location-allocation problem type parameter of this tool . |
void |
setNumberFacilitiesToFind(int numberFacilitiesToFind)
Sets the Number of facilities to find parameter of this tool . |
void |
setOutNetworkAnalysisLayer(java.lang.String outNetworkAnalysisLayer)
Sets the Output layer name parameter of this tool . |
void |
setOutputPathShape(java.lang.String outputPathShape)
Sets the Output path shape parameter of this tool . |
void |
setRestrictionAttributeName(java.lang.Object restrictionAttributeName)
Sets the Restrictions parameter of this tool . |
void |
setTargetMarketShare(double targetMarketShare)
Sets the Target market share parameter of this tool . |
void |
setUTurnPolicy(java.lang.String uTurnPolicy)
Sets the U-turn policy parameter of this tool . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MakeLocationAllocationLayer
public MakeLocationAllocationLayer()
- Creates the Make Location-Allocation Layer tool with defaults.
Initializes the array of tool parameters with the default values specified when the tool was created.
MakeLocationAllocationLayer
public MakeLocationAllocationLayer(java.lang.Object inNetworkDataset,
java.lang.String outNetworkAnalysisLayer,
java.lang.String impedanceAttribute)
- Creates the Make Location-Allocation Layer tool with the required parameters.
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
- Parameters:
inNetworkDataset
- the network dataset on which the location-allocation analysis will be performed.outNetworkAnalysisLayer
- name of the location-allocation network analysis layer to create.impedanceAttribute
- the cost attribute to be used as impedance in the analysis.
getInNetworkDataset
public java.lang.Object getInNetworkDataset()
- Returns the Input analysis network parameter of this tool .
This parameter is the network dataset on which the location-allocation analysis will be performed.
This is a required parameter.
- Returns:
- the Input analysis network
setInNetworkDataset
public void setInNetworkDataset(java.lang.Object inNetworkDataset)
- Sets the Input analysis network parameter of this tool .
This parameter is the network dataset on which the location-allocation analysis will be performed.
This is a required parameter.
- Parameters:
inNetworkDataset
- the network dataset on which the location-allocation analysis will be performed.
getOutNetworkAnalysisLayer
public java.lang.String getOutNetworkAnalysisLayer()
- Returns the Output layer name parameter of this tool .
This parameter is name of the location-allocation network analysis layer to create.
This is a required parameter.
- Returns:
- the Output layer name
setOutNetworkAnalysisLayer
public void setOutNetworkAnalysisLayer(java.lang.String outNetworkAnalysisLayer)
- Sets the Output layer name parameter of this tool .
This parameter is name of the location-allocation network analysis layer to create.
This is a required parameter.
- Parameters:
outNetworkAnalysisLayer
- name of the location-allocation network analysis layer to create.
getImpedanceAttribute
public java.lang.String getImpedanceAttribute()
- Returns the Impedance attribute parameter of this tool .
This parameter is the cost attribute to be used as impedance in the analysis.
This is a required parameter.
- Returns:
- the Impedance attribute
setImpedanceAttribute
public void setImpedanceAttribute(java.lang.String impedanceAttribute)
- Sets the Impedance attribute parameter of this tool .
This parameter is the cost attribute to be used as impedance in the analysis.
This is a required parameter.
- Parameters:
impedanceAttribute
- the cost attribute to be used as impedance in the analysis.
getLocAllocFromTo
public java.lang.String getLocAllocFromTo()
- Returns the Travel from parameter of this tool .
This parameter is specifies the direction of travel between facilities and demand points when calculating the network costs. using this option can affect the allocation of the demand points to the facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, a facility may be a 15-minute drive from the demand point to the facility, but only a 10-minute trip when traveling from the facility to the demand point. fire departments commonly use the Facility to Demand setting, since they are concerned with the time it takes to travel from the fire station to the location of the emergency. A retail store is more concerned with the time it takes the shoppers to reach the store; therefore, stores commonly use the Demand to Facility option.
This is an optional parameter.
- Returns:
- the Travel from
setLocAllocFromTo
public void setLocAllocFromTo(java.lang.String locAllocFromTo)
- Sets the Travel from parameter of this tool .
This parameter is specifies the direction of travel between facilities and demand points when calculating the network costs. using this option can affect the allocation of the demand points to the facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, a facility may be a 15-minute drive from the demand point to the facility, but only a 10-minute trip when traveling from the facility to the demand point. fire departments commonly use the Facility to Demand setting, since they are concerned with the time it takes to travel from the fire station to the location of the emergency. A retail store is more concerned with the time it takes the shoppers to reach the store; therefore, stores commonly use the Demand to Facility option.
This is an optional parameter.
- Parameters:
locAllocFromTo
- specifies the direction of travel between facilities and demand points when calculating the network costs. using this option can affect the allocation of the demand points to the facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, a facility may be a 15-minute drive from the demand point to the facility, but only a 10-minute trip when traveling from the facility to the demand point. fire departments commonly use the Facility to Demand setting, since they are concerned with the time it takes to travel from the fire station to the location of the emergency. A retail store is more concerned with the time it takes the shoppers to reach the store; therefore, stores commonly use the Demand to Facility option.
getLocAllocProblemType
public java.lang.String getLocAllocProblemType()
- Returns the Location-allocation problem type parameter of this tool .
This parameter is the problem type that will be solved. The choice of the problem type depends on the kind of facility being located. Different kinds of facilities have different priorities and constraints.
This is an optional parameter.
- Returns:
- the Location-allocation problem type
setLocAllocProblemType
public void setLocAllocProblemType(java.lang.String locAllocProblemType)
- Sets the Location-allocation problem type parameter of this tool .
This parameter is the problem type that will be solved. The choice of the problem type depends on the kind of facility being located. Different kinds of facilities have different priorities and constraints.
This is an optional parameter.
- Parameters:
locAllocProblemType
- the problem type that will be solved. The choice of the problem type depends on the kind of facility being located. Different kinds of facilities have different priorities and constraints.
getNumberFacilitiesToFind
public int getNumberFacilitiesToFind()
- Returns the Number of facilities to find parameter of this tool .
This parameter is specifies the number of facilities that the solver should locate. the facilities with a FacilityType value of Required are always part of the solution when there are more facilities to find than required facilities; any excess facilities to choose are picked from candidate facilities. any facilities that have a FacilityType value of Chosen before solving are treated as candidate facilities at solve time. the parameter value is not considered for the MINIMIZE_FACILITIES problem type since the solver determines the minimum number of facilities to locate to maximize coverage. the parameter value is overridden for the TARGET_MARKET_SHARE problem type because the solver searches for the minimum number of facilities required to capture the specified market share.
This is an optional parameter.
- Returns:
- the Number of facilities to find
setNumberFacilitiesToFind
public void setNumberFacilitiesToFind(int numberFacilitiesToFind)
- Sets the Number of facilities to find parameter of this tool .
This parameter is specifies the number of facilities that the solver should locate. the facilities with a FacilityType value of Required are always part of the solution when there are more facilities to find than required facilities; any excess facilities to choose are picked from candidate facilities. any facilities that have a FacilityType value of Chosen before solving are treated as candidate facilities at solve time. the parameter value is not considered for the MINIMIZE_FACILITIES problem type since the solver determines the minimum number of facilities to locate to maximize coverage. the parameter value is overridden for the TARGET_MARKET_SHARE problem type because the solver searches for the minimum number of facilities required to capture the specified market share.
This is an optional parameter.
- Parameters:
numberFacilitiesToFind
- specifies the number of facilities that the solver should locate. the facilities with a FacilityType value of Required are always part of the solution when there are more facilities to find than required facilities; any excess facilities to choose are picked from candidate facilities. any facilities that have a FacilityType value of Chosen before solving are treated as candidate facilities at solve time. the parameter value is not considered for the MINIMIZE_FACILITIES problem type since the solver determines the minimum number of facilities to locate to maximize coverage. the parameter value is overridden for the TARGET_MARKET_SHARE problem type because the solver searches for the minimum number of facilities required to capture the specified market share.
getImpedanceCutoff
public double getImpedanceCutoff()
- Returns the Impedance cutoff parameter of this tool .
This parameter is impedance Cutoff specifies the maximum impedance at which a demand point can be allocated to a facility. The maximum impedance is measured by the least-cost path along the network. If a demand point is outside the cutoff, it is left unallocated. This property might be used to model the maximum distance that people are willing to travel to visit your stores or the maximum time that is permitted for a fire department to reach anyone in the community. demand points have a Cutoff_[Impedance] property, which, if set, overrides the Impedance Cutoff property of the analysis layer. 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 two miles. You can model this behavior by setting the impedance cutoff value of the analysis layer to 10 and setting the Cutoff_Miles value of the demand points in urban areas to 2.
This is an optional parameter.
- Returns:
- the Impedance cutoff
setImpedanceCutoff
public void setImpedanceCutoff(double impedanceCutoff)
- Sets the Impedance cutoff parameter of this tool .
This parameter is impedance Cutoff specifies the maximum impedance at which a demand point can be allocated to a facility. The maximum impedance is measured by the least-cost path along the network. If a demand point is outside the cutoff, it is left unallocated. This property might be used to model the maximum distance that people are willing to travel to visit your stores or the maximum time that is permitted for a fire department to reach anyone in the community. demand points have a Cutoff_[Impedance] property, which, if set, overrides the Impedance Cutoff property of the analysis layer. 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 two miles. You can model this behavior by setting the impedance cutoff value of the analysis layer to 10 and setting the Cutoff_Miles value of the demand points in urban areas to 2.
This is an optional parameter.
- Parameters:
impedanceCutoff
- impedance Cutoff specifies the maximum impedance at which a demand point can be allocated to a facility. The maximum impedance is measured by the least-cost path along the network. If a demand point is outside the cutoff, it is left unallocated. This property might be used to model the maximum distance that people are willing to travel to visit your stores or the maximum time that is permitted for a fire department to reach anyone in the community. demand points have a Cutoff_[Impedance] property, which, if set, overrides the Impedance Cutoff property of the analysis layer. 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 two miles. You can model this behavior by setting the impedance cutoff value of the analysis layer to 10 and setting the Cutoff_Miles value of the demand points in urban areas to 2.
getImpedanceTransformation
public java.lang.String getImpedanceTransformation()
- Returns the Impedance transformation parameter of this tool .
This parameter is this sets the equation for transforming the network cost between facilities and demand points. This property, coupled with the Impedance Parameter, specifies how severely the network impedance between facilities and demand points influences the solver's choice of facilities. demand points have an ImpedanceTransformation property, which if set, overrides the Impedance Transformation property of the analysis layer. You might determine the impedance transformation should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the demand points in urban areas to match that of urbanites.
This is an optional parameter.
- Returns:
- the Impedance transformation
setImpedanceTransformation
public void setImpedanceTransformation(java.lang.String impedanceTransformation)
- Sets the Impedance transformation parameter of this tool .
This parameter is this sets the equation for transforming the network cost between facilities and demand points. This property, coupled with the Impedance Parameter, specifies how severely the network impedance between facilities and demand points influences the solver's choice of facilities. demand points have an ImpedanceTransformation property, which if set, overrides the Impedance Transformation property of the analysis layer. You might determine the impedance transformation should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the demand points in urban areas to match that of urbanites.
This is an optional parameter.
- Parameters:
impedanceTransformation
- this sets the equation for transforming the network cost between facilities and demand points. This property, coupled with the Impedance Parameter, specifies how severely the network impedance between facilities and demand points influences the solver's choice of facilities. demand points have an ImpedanceTransformation property, which if set, overrides the Impedance Transformation property of the analysis layer. You might determine the impedance transformation should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the demand points in urban areas to match that of urbanites.
getImpedanceParameter
public double getImpedanceParameter()
- Returns the Impedance parameter parameter of this tool .
This parameter is provides a parameter value to the equations specified in the Impedance transformation parameter. The parameter value is ignored when the impedance transformation is of type linear. For power and exponential impedance transformations, the value should be non-zero. demand points have an ImpedanceParameter property, which, if set, overrides the Impedance Parameter property of the analysis layer. You might determine that the impedance parameter should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the demand points in urban areas to match that of urbanites.
This is an optional parameter.
- Returns:
- the Impedance parameter
setImpedanceParameter
public void setImpedanceParameter(double impedanceParameter)
- Sets the Impedance parameter parameter of this tool .
This parameter is provides a parameter value to the equations specified in the Impedance transformation parameter. The parameter value is ignored when the impedance transformation is of type linear. For power and exponential impedance transformations, the value should be non-zero. demand points have an ImpedanceParameter property, which, if set, overrides the Impedance Parameter property of the analysis layer. You might determine that the impedance parameter should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the demand points in urban areas to match that of urbanites.
This is an optional parameter.
- Parameters:
impedanceParameter
- provides a parameter value to the equations specified in the Impedance transformation parameter. The parameter value is ignored when the impedance transformation is of type linear. For power and exponential impedance transformations, the value should be non-zero. demand points have an ImpedanceParameter property, which, if set, overrides the Impedance Parameter property of the analysis layer. You might determine that the impedance parameter should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the demand points in urban areas to match that of urbanites.
getTargetMarketShare
public double getTargetMarketShare()
- Returns the Target market share parameter of this tool .
This parameter is specifies the target market share in percentage to solve for when the Location-allocation problem type parameter is set to TARGET_MARKET_SHARE. It is the percentage of the total demand weight that you want your solution facilities to capture. The solver chooses the minimum number of facilities required to capture the target market share specified by this numeric value.
This is an optional parameter.
- Returns:
- the Target market share
setTargetMarketShare
public void setTargetMarketShare(double targetMarketShare)
- Sets the Target market share parameter of this tool .
This parameter is specifies the target market share in percentage to solve for when the Location-allocation problem type parameter is set to TARGET_MARKET_SHARE. It is the percentage of the total demand weight that you want your solution facilities to capture. The solver chooses the minimum number of facilities required to capture the target market share specified by this numeric value.
This is an optional parameter.
- Parameters:
targetMarketShare
- specifies the target market share in percentage to solve for when the Location-allocation problem type parameter is set to TARGET_MARKET_SHARE. It is the percentage of the total demand weight that you want your solution facilities to capture. The solver chooses the minimum number of facilities required to capture the target market share specified by this numeric value.
getAccumulateAttributeName
public java.lang.Object getAccumulateAttributeName()
- Returns the Accumulators parameter of this tool .
This parameter is list of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Impedance attribute parameter to calculate the route. for each cost attribute that is accumulated, a Total_[Impedance] property is added to the routes that are output by the solver.
This is an optional parameter.
- Returns:
- the Accumulators
setAccumulateAttributeName
public void setAccumulateAttributeName(java.lang.Object accumulateAttributeName)
- Sets the Accumulators parameter of this tool .
This parameter is list of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Impedance attribute parameter to calculate the route. for each cost attribute that is accumulated, a Total_[Impedance] property is added to the routes that are output by the solver.
This is an optional parameter.
- Parameters:
accumulateAttributeName
- list of cost attributes to be accumulated during analysis. These accumulation attributes are purely for reference; the solver only uses the cost attribute specified by the Impedance attribute parameter to calculate the route. for each cost attribute that is accumulated, a Total_[Impedance] property is added to the routes that are output by the solver.
getUTurnPolicy
public java.lang.String getUTurnPolicy()
- Returns the U-turn policy parameter of this tool .
This parameter is restrict or permit U-turns at junctions that could occur during network traversal between stops.
This is an optional parameter.
- Returns:
- the U-turn policy
setUTurnPolicy
public void setUTurnPolicy(java.lang.String uTurnPolicy)
- Sets the U-turn policy parameter of this tool .
This parameter is restrict or permit U-turns at junctions that could occur during network traversal between stops.
This is an optional parameter.
- Parameters:
uTurnPolicy
- restrict or permit U-turns at junctions that could occur during network traversal between stops.
getRestrictionAttributeName
public java.lang.Object getRestrictionAttributeName()
- Returns the Restrictions parameter of this tool .
This parameter is list of restriction attributes to apply during the analysis.
This is an optional parameter.
- Returns:
- the Restrictions
setRestrictionAttributeName
public void setRestrictionAttributeName(java.lang.Object restrictionAttributeName)
- Sets the Restrictions parameter of this tool .
This parameter is list of restriction attributes to apply during the analysis.
This is an optional parameter.
- Parameters:
restrictionAttributeName
- list of restriction attributes to apply during the analysis.
getHierarchy
public java.lang.String getHierarchy()
- Returns the Use hierarchy in analysis parameter of this tool .
This parameter is the parameter is not used if a hierarchy attribute is not defined on the network dataset used to perform the analysis. In such cases, use "#" as the parameter value.
This is an optional parameter.
- Returns:
- the Use hierarchy in analysis
setHierarchy
public void setHierarchy(java.lang.String hierarchy)
- Sets the Use hierarchy in analysis parameter of this tool .
This parameter is the parameter is not used if a hierarchy attribute is not defined on the network dataset used to perform the analysis. In such cases, use "#" as the parameter value.
This is an optional parameter.
- Parameters:
hierarchy
- the parameter is not used if a hierarchy attribute is not defined on the network dataset used to perform the analysis. In such cases, use "#" as the parameter value.
getOutputPathShape
public java.lang.String getOutputPathShape()
- Returns the Output path shape parameter of this tool .
This is an optional parameter.
- Returns:
- the Output path shape
setOutputPathShape
public void setOutputPathShape(java.lang.String outputPathShape)
- Sets the Output path shape parameter of this tool .
This is an optional parameter.
- Parameters:
outputPathShape
- null
getOutputLayer
public java.lang.Object getOutputLayer()
- Returns the Network Analyst Layer parameter of this tool (Read only).
This is an derived parameter.
- Returns:
- the Network Analyst Layer
getToolName
public java.lang.String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public java.lang.String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public java.lang.String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias