com.esri.arcgis.geoprocessing.tools.networkanalysttools
Class MakeClosestFacilityLayer

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.networkanalysttools.MakeClosestFacilityLayer

All Implemented Interfaces:

GPTool

public class MakeClosestFacilityLayer
extends AbstractGPTool

Makes a closest facility network analysis layer and sets its navigation properties. The Make Closest Facility Layer tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:

• A Closest Facility layer can be made on a network currently added to the ArcMap table of contents or you can browse to a network dataset on disk.
• Hierarchy options can only be set if the input analysis network has a hierarchy attribute.
• Learn more about Closest Facility analysis.;
• The following environment settings affect this tool: workspace;

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

MakeClosestFacilityLayer()
Creates the Make Closest Facility Layer tool with defaults.

MakeClosestFacilityLayer(Object inNetworkDataset, String outNetworkAnalysisLayer, String impedanceAttribute)
Creates the Make Closest Facility Layer tool with the required parameters.

Method Summary

Object	getAccumulateAttributeName() Returns the Accumulators parameter of this tool .
double	getDefaultCutoff() Returns the Default cutoff parameter of this tool .
int	getDefaultNumberFacilitiesToFind() Returns the Number of facilities to find parameter of this tool .
String	getHierarchy() Returns the Use hierarchy in analysis parameter of this tool .
Object	getHierarchySettings() Returns the Hierarchy rank settings parameter of this tool .
String	getImpedanceAttribute() Returns the Impedance attribute parameter of this tool .
Object	getInNetworkDataset() Returns the Input analysis network parameter of this tool .
String	getOutNetworkAnalysisLayer() Returns the Output layer name parameter of this tool .
Object	getOutputLayer() Returns the Network Analyst Layer parameter of this tool (Read only).
String	getOutputPathShape() Returns the Output path shape parameter of this tool .
Object	getRestrictionAttributeName() Returns the Restrictions parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
String	getTravelFromTo() Returns the Travel from or to facility parameter of this tool .
String	getUTurnPolicy() Returns the U-turn policy parameter of this tool .
void	setAccumulateAttributeName(Object accumulateAttributeName) Sets the Accumulators parameter of this tool .
void	setDefaultCutoff(double defaultCutoff) Sets the Default cutoff parameter of this tool .
void	setDefaultNumberFacilitiesToFind(int defaultNumberFacilitiesToFind) Sets the Number of facilities to find parameter of this tool .
void	setHierarchy(String hierarchy) Sets the Use hierarchy in analysis parameter of this tool .
void	setHierarchySettings(Object hierarchySettings) Sets the Hierarchy rank settings parameter of this tool .
void	setImpedanceAttribute(String impedanceAttribute) Sets the Impedance attribute parameter of this tool .
void	setInNetworkDataset(Object inNetworkDataset) Sets the Input analysis network parameter of this tool .
void	setOutNetworkAnalysisLayer(String outNetworkAnalysisLayer) Sets the Output layer name parameter of this tool .
void	setOutputPathShape(String outputPathShape) Sets the Output path shape parameter of this tool .
void	setRestrictionAttributeName(Object restrictionAttributeName) Sets the Restrictions parameter of this tool .
void	setTravelFromTo(String travelFromTo) Sets the Travel from or to facility parameter of this tool .
void	setUTurnPolicy(String uTurnPolicy) Sets the U-turn policy parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MakeClosestFacilityLayer

public MakeClosestFacilityLayer()

Creates the Make Closest Facility Layer tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

MakeClosestFacilityLayer

public MakeClosestFacilityLayer(Object inNetworkDataset,
                                String outNetworkAnalysisLayer,
                                String impedanceAttribute)

Creates the Make Closest Facility 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 - Network Dataset Layer, the network dataset on which the closest facility analysis will be performed.

outNetworkAnalysisLayer - String, name of the closest facility network analysis layer being created.

impedanceAttribute - String, the cost attribute to be used as impedance in the analysis.

Method Detail

getInNetworkDataset

public Object getInNetworkDataset()

Returns the Input analysis network parameter of this tool . This parameter is Network Dataset Layer, the network dataset on which the closest facility analysis will be performed. This is a required parameter.

Returns:

the Input analysis network

setInNetworkDataset

public void setInNetworkDataset(Object inNetworkDataset)

Sets the Input analysis network parameter of this tool . This parameter is Network Dataset Layer, the network dataset on which the closest facility analysis will be performed. This is a required parameter.

Parameters:

inNetworkDataset - Network Dataset Layer, the network dataset on which the closest facility analysis will be performed.

getOutNetworkAnalysisLayer

public String getOutNetworkAnalysisLayer()

Returns the Output layer name parameter of this tool . This parameter is String, name of the closest facility network analysis layer being created. This is a required parameter.

Returns:

the Output layer name

setOutNetworkAnalysisLayer

public void setOutNetworkAnalysisLayer(String outNetworkAnalysisLayer)

Sets the Output layer name parameter of this tool . This parameter is String, name of the closest facility network analysis layer being created. This is a required parameter.

Parameters:

outNetworkAnalysisLayer - String, name of the closest facility network analysis layer being created.

getImpedanceAttribute

public String getImpedanceAttribute()

Returns the Impedance attribute parameter of this tool . This parameter is String, the cost attribute to be used as impedance in the analysis. This is a required parameter.

Returns:

the Impedance attribute

setImpedanceAttribute

public void setImpedanceAttribute(String impedanceAttribute)

Sets the Impedance attribute parameter of this tool . This parameter is String, the cost attribute to be used as impedance in the analysis. This is a required parameter.

Parameters:

impedanceAttribute - String, the cost attribute to be used as impedance in the analysis.

getTravelFromTo

public String getTravelFromTo()

Returns the Travel from or to facility parameter of this tool . This parameter is String, specifies the direction between facilities and incidents. This is an optional parameter.

Returns:

the Travel from or to facility

setTravelFromTo

public void setTravelFromTo(String travelFromTo)

Sets the Travel from or to facility parameter of this tool . This parameter is String, specifies the direction between facilities and incidents. This is an optional parameter.

Parameters:

travelFromTo - String, specifies the direction between facilities and incidents.

getDefaultCutoff

public double getDefaultCutoff()

Returns the Default cutoff parameter of this tool . This parameter is Double, default impedance value at which to cut off searching for facilities for a given incident. The default can be overriden by the value of the for the facility or incident. The minimum of the specified cutoffs for a given facilityincident pair is used to constrain the analysis. This is an optional parameter.

Returns:

the Default cutoff

setDefaultCutoff

public void setDefaultCutoff(double defaultCutoff)

Sets the Default cutoff parameter of this tool . This parameter is Double, default impedance value at which to cut off searching for facilities for a given incident. The default can be overriden by the value of the for the facility or incident. The minimum of the specified cutoffs for a given facilityincident pair is used to constrain the analysis. This is an optional parameter.

Parameters:

defaultCutoff - Double, default impedance value at which to cut off searching for facilities for a given incident. The default can be overriden by the value of the for the facility or incident. The minimum of the specified cutoffs for a given facilityincident pair is used to constrain the analysis.

getDefaultNumberFacilitiesToFind

public int getDefaultNumberFacilitiesToFind()

Returns the Number of facilities to find parameter of this tool . This parameter is Long, default number of closest facilities to find per incident. The default can be overridden by the value of the TargetFacilityCount property of the incidents. This is an optional parameter.

Returns:

the Number of facilities to find

setDefaultNumberFacilitiesToFind

public void setDefaultNumberFacilitiesToFind(int defaultNumberFacilitiesToFind)

Sets the Number of facilities to find parameter of this tool . This parameter is Long, default number of closest facilities to find per incident. The default can be overridden by the value of the TargetFacilityCount property of the incidents. This is an optional parameter.

Parameters:

defaultNumberFacilitiesToFind - Long, default number of closest facilities to find per incident. The default can be overridden by the value of the TargetFacilityCount property of the incidents.

getAccumulateAttributeName

public Object getAccumulateAttributeName()

Returns the Accumulators parameter of this tool . This parameter is String, list of cost attributes to be accumulated during analysis. This is an optional parameter.

Returns:

the Accumulators

setAccumulateAttributeName

public void setAccumulateAttributeName(Object accumulateAttributeName)

Sets the Accumulators parameter of this tool . This parameter is String, list of cost attributes to be accumulated during analysis. This is an optional parameter.

Parameters:

accumulateAttributeName - String, list of cost attributes to be accumulated during analysis.

getUTurnPolicy

public String getUTurnPolicy()

Returns the U-turn policy parameter of this tool . This parameter is String, specifies optional U-turn restrictions. This is an optional parameter.

Returns:

the U-turn policy

setUTurnPolicy

public void setUTurnPolicy(String uTurnPolicy)

Sets the U-turn policy parameter of this tool . This parameter is String, specifies optional U-turn restrictions. This is an optional parameter.

Parameters:

uTurnPolicy - String, specifies optional U-turn restrictions.

getRestrictionAttributeName

public Object getRestrictionAttributeName()

Returns the Restrictions parameter of this tool . This parameter is String, list of restriction attributes to be honored during analysis. This is an optional parameter.

Returns:

the Restrictions

setRestrictionAttributeName

public void setRestrictionAttributeName(Object restrictionAttributeName)

Sets the Restrictions parameter of this tool . This parameter is String, list of restriction attributes to be honored during analysis. This is an optional parameter.

Parameters:

restrictionAttributeName - String, list of restriction attributes to be honored during analysis.

getHierarchy

public String getHierarchy()

Returns the Use hierarchy in analysis parameter of this tool . This parameter is String, specify whether or not to use a hierarchy in the analysis. This is an optional parameter.

Returns:

the Use hierarchy in analysis

setHierarchy

public void setHierarchy(String hierarchy)

Sets the Use hierarchy in analysis parameter of this tool . This parameter is String, specify whether or not to use a hierarchy in the analysis. This is an optional parameter.

Parameters:

hierarchy - String, specify whether or not to use a hierarchy in the analysis.

getHierarchySettings

public Object getHierarchySettings()

Returns the Hierarchy rank settings parameter of this tool . This parameter is Network Analyst Hierarchy Settings, sets the hierarchy attribute values at which the navigation algorithm should form the highest, middle, and lowest ranks. The value is specified as a space-separated string containing two integers whose values must be greater than zero. The integers indicate low-to-mid and mid-to-high break values. The two integers must have their values in increasing order. For example, a value of "6 8" indicates that the primary roads are defined by the values of one to six, secondary roads by seven, and local roads by eight and higher. This is an optional parameter.

Returns:

the Hierarchy rank settings

setHierarchySettings

public void setHierarchySettings(Object hierarchySettings)

Sets the Hierarchy rank settings parameter of this tool . This parameter is Network Analyst Hierarchy Settings, sets the hierarchy attribute values at which the navigation algorithm should form the highest, middle, and lowest ranks. The value is specified as a space-separated string containing two integers whose values must be greater than zero. The integers indicate low-to-mid and mid-to-high break values. The two integers must have their values in increasing order. For example, a value of "6 8" indicates that the primary roads are defined by the values of one to six, secondary roads by seven, and local roads by eight and higher. This is an optional parameter.

Parameters:

hierarchySettings - Network Analyst Hierarchy Settings, sets the hierarchy attribute values at which the navigation algorithm should form the highest, middle, and lowest ranks. The value is specified as a space-separated string containing two integers whose values must be greater than zero. The integers indicate low-to-mid and mid-to-high break values. The two integers must have their values in increasing order. For example, a value of "6 8" indicates that the primary roads are defined by the values of one to six, secondary roads by seven, and local roads by eight and higher.

getOutputPathShape

public String getOutputPathShape()

Returns the Output path shape parameter of this tool . This parameter is String, in some situations, it may not be possible to compute the measures, and the lines will be output without measures. This is an optional parameter.

Returns:

the Output path shape

setOutputPathShape

public void setOutputPathShape(String outputPathShape)

Sets the Output path shape parameter of this tool . This parameter is String, in some situations, it may not be possible to compute the measures, and the lines will be output without measures. This is an optional parameter.

Parameters:

outputPathShape - String, in some situations, it may not be possible to compute the measures, and the lines will be output without measures.

getOutputLayer

public 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 String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias