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 analysis properties. A closest facility analysis layer is useful in determining the closest facility or facilities to an incident based on a specified network cost. The Make Closest Facility 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.

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 - the network dataset on which the closest facility analysis will be performed.

outNetworkAnalysisLayer - name of the closest facility network analysis layer to create.

impedanceAttribute - 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 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 the network dataset on which the closest facility analysis will be performed. This is a required parameter.

Parameters:

inNetworkDataset - 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 name of the closest facility network analysis layer to create. 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 name of the closest facility network analysis layer to create. This is a required parameter.

Parameters:

outNetworkAnalysisLayer - name of the closest facility network analysis layer to create.

getImpedanceAttribute

public 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(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.

getTravelFromTo

public String getTravelFromTo()

Returns the Travel from or to facility parameter of this tool . This parameter is specifies the direction of travel between facilities and incidents. using this option can find different facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, a facility may be a 10-minute drive from the incident while traveling from the incident to the facility, but while traveling from the facility to the incident, it may be a 15-minute journey because of different travel time in that direction. fire departments commonly use the TRAVEL_FROM setting since they are concerned with the time it takes to travel from the fire station (facility) to the location of the emergency (incident). A retail store (facility) is more concerned with the time it takes the shoppers (incidents) to reach the store; therefore, stores commonly use the TRAVEL_TO option. 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 specifies the direction of travel between facilities and incidents. using this option can find different facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, a facility may be a 10-minute drive from the incident while traveling from the incident to the facility, but while traveling from the facility to the incident, it may be a 15-minute journey because of different travel time in that direction. fire departments commonly use the TRAVEL_FROM setting since they are concerned with the time it takes to travel from the fire station (facility) to the location of the emergency (incident). A retail store (facility) is more concerned with the time it takes the shoppers (incidents) to reach the store; therefore, stores commonly use the TRAVEL_TO option. This is an optional parameter.

Parameters:

travelFromTo - specifies the direction of travel between facilities and incidents. using this option can find different facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, a facility may be a 10-minute drive from the incident while traveling from the incident to the facility, but while traveling from the facility to the incident, it may be a 15-minute journey because of different travel time in that direction. fire departments commonly use the TRAVEL_FROM setting since they are concerned with the time it takes to travel from the fire station (facility) to the location of the emergency (incident). A retail store (facility) is more concerned with the time it takes the shoppers (incidents) to reach the store; therefore, stores commonly use the TRAVEL_TO option.

getDefaultCutoff

public double getDefaultCutoff()

Returns the Default cutoff parameter of this tool . This parameter is default impedance value at which to stop searching for facilities for a given incident. The default can be overridden by specifying the cutoff value on incidents when TRAVEL_TO option is used or by specifying the cutoff value on facilities when TRAVEL_FROM option is used. 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 default impedance value at which to stop searching for facilities for a given incident. The default can be overridden by specifying the cutoff value on incidents when TRAVEL_TO option is used or by specifying the cutoff value on facilities when TRAVEL_FROM option is used. This is an optional parameter.

Parameters:

defaultCutoff - default impedance value at which to stop searching for facilities for a given incident. The default can be overridden by specifying the cutoff value on incidents when TRAVEL_TO option is used or by specifying the cutoff value on facilities when TRAVEL_FROM option is used.

getDefaultNumberFacilitiesToFind

public int getDefaultNumberFacilitiesToFind()

Returns the Number of facilities to find parameter of this tool . This parameter is default number of closest facilities to find per incident. The default can be overridden by specifying a value for the TargetFacilityCount property on 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 default number of closest facilities to find per incident. The default can be overridden by specifying a value for the TargetFacilityCount property on the incidents. This is an optional parameter.

Parameters:

defaultNumberFacilitiesToFind - default number of closest facilities to find per incident. The default can be overridden by specifying a value for the TargetFacilityCount property on the incidents.

getAccumulateAttributeName

public 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(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 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(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 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(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 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(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.

getHierarchySettings

public Object getHierarchySettings()

Returns the Hierarchy rank settings parameter of this tool . 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 is an optional parameter.

Parameters:

hierarchySettings - null

getOutputPathShape

public String getOutputPathShape()

Returns the Output path shape parameter of this tool . This parameter is specifies the shape type for the route features that are output by the analysis. no matter which output shape type is chosen, the best route is always determined by the network impedance, never Euclidean distance. This means only the route shapes are different, not the underlying traversal of the network. 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 specifies the shape type for the route features that are output by the analysis. no matter which output shape type is chosen, the best route is always determined by the network impedance, never Euclidean distance. This means only the route shapes are different, not the underlying traversal of the network. This is an optional parameter.

Parameters:

outputPathShape - specifies the shape type for the route features that are output by the analysis. no matter which output shape type is chosen, the best route is always determined by the network impedance, never Euclidean distance. This means only the route shapes are different, not the underlying traversal of the network.

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