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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.networkanalysttools.CalculateLocations
All Implemented Interfaces:
GPTool

public class CalculateLocations
extends AbstractGPTool

Calculates the network location fields for a point feature class. The Calculate Locations tool is contained in the Network Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculateLocations()
          Creates the Calculate Locations tool with defaults.
CalculateLocations(Object inPointFeatures, Object inNetworkDataset, Object searchTolerance, Object searchCriteria)
          Creates the Calculate Locations tool with the required parameters.
 
Method Summary
 Object getDistanceField()
          Returns the Distance from feature field parameter of this tool .
 Object getInNetworkDataset()
          Returns the Input analysis network parameter of this tool .
 Object getInPointFeatures()
          Returns the Input point features parameter of this tool .
 String getMatchType()
          Returns the Find closest among all classes parameter of this tool .
 Object getOutPointFeatureClass()
          Returns the Output derived point feature class parameter of this tool (Read only).
 Object getPositionField()
          Returns the Percent along field parameter of this tool .
 Object getSearchCriteria()
          Returns the Search criteria parameter of this tool .
 Object getSearchTolerance()
          Returns the Search tolerance parameter of this tool .
 Object getSideField()
          Returns the Side of edge field parameter of this tool .
 Object getSnapXField()
          Returns the Located X-coordinate field parameter of this tool .
 Object getSnapYField()
          Returns the Located Y-coordinate field parameter of this tool .
 Object getSourceIDField()
          Returns the Source ID field parameter of this tool .
 Object getSourceOIDField()
          Returns the Source OID field 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.
 void setDistanceField(Object distanceField)
          Sets the Distance from feature field parameter of this tool .
 void setInNetworkDataset(Object inNetworkDataset)
          Sets the Input analysis network parameter of this tool .
 void setInPointFeatures(Object inPointFeatures)
          Sets the Input point features parameter of this tool .
 void setMatchType(String matchType)
          Sets the Find closest among all classes parameter of this tool .
 void setPositionField(Object positionField)
          Sets the Percent along field parameter of this tool .
 void setSearchCriteria(Object searchCriteria)
          Sets the Search criteria parameter of this tool .
 void setSearchTolerance(Object searchTolerance)
          Sets the Search tolerance parameter of this tool .
 void setSideField(Object sideField)
          Sets the Side of edge field parameter of this tool .
 void setSnapXField(Object snapXField)
          Sets the Located X-coordinate field parameter of this tool .
 void setSnapYField(Object snapYField)
          Sets the Located Y-coordinate field parameter of this tool .
 void setSourceIDField(Object sourceIDField)
          Sets the Source ID field parameter of this tool .
 void setSourceOIDField(Object sourceOIDField)
          Sets the Source OID field 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

CalculateLocations

public CalculateLocations()
Creates the Calculate Locations tool with defaults.

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


CalculateLocations

public CalculateLocations(Object inPointFeatures,
                          Object inNetworkDataset,
                          Object searchTolerance,
                          Object searchCriteria)
Creates the Calculate Locations 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:
inPointFeatures - Table View, the input point features for which locations will be calculated.
inNetworkDataset - Network Dataset Layer, the network analysis layer that will be used to calculate the locations.
searchTolerance - Linear unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance.
searchCriteria - (String String; String String;...), allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying their subtypes.
Method Detail

getInPointFeatures

public Object getInPointFeatures()
Returns the Input point features parameter of this tool . This parameter is Table View, the input point features for which locations will be calculated. This is a required parameter.

Returns:
the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)
Sets the Input point features parameter of this tool . This parameter is Table View, the input point features for which locations will be calculated. This is a required parameter.

Parameters:
inPointFeatures - Table View, the input point features for which locations will be calculated.

getInNetworkDataset

public Object getInNetworkDataset()
Returns the Input analysis network parameter of this tool . This parameter is Network Dataset Layer, the network analysis layer that will be used to calculate the locations. 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 analysis layer that will be used to calculate the locations. This is a required parameter.

Parameters:
inNetworkDataset - Network Dataset Layer, the network analysis layer that will be used to calculate the locations.

getSearchTolerance

public Object getSearchTolerance()
Returns the Search tolerance parameter of this tool . This parameter is Linear unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance. This is a required parameter.

Returns:
the Search tolerance

setSearchTolerance

public void setSearchTolerance(Object searchTolerance)
Sets the Search tolerance parameter of this tool . This parameter is Linear unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance. This is a required parameter.

Parameters:
searchTolerance - Linear unit, the search tolerance for locating the input features on the network. The parameter includes a value and units for the tolerance.

getSearchCriteria

public Object getSearchCriteria()
Returns the Search criteria parameter of this tool . This parameter is (String String; String String;...), allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying their subtypes. This is a required parameter.

Returns:
the Search criteria

setSearchCriteria

public void setSearchCriteria(Object searchCriteria)
Sets the Search criteria parameter of this tool . This parameter is (String String; String String;...), allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying their subtypes. This is a required parameter.

Parameters:
searchCriteria - (String String; String String;...), allows you to specify which sources in your network dataset will be searched when finding locations, as well as specifying their subtypes.

getMatchType

public String getMatchType()
Returns the Find closest among all classes parameter of this tool . This parameter is String, specifies if the location of the point feature to the closest feature layer in the network gets calculated. This is an optional parameter.

Returns:
the Find closest among all classes

setMatchType

public void setMatchType(String matchType)
Sets the Find closest among all classes parameter of this tool . This parameter is String, specifies if the location of the point feature to the closest feature layer in the network gets calculated. This is an optional parameter.

Parameters:
matchType - String, specifies if the location of the point feature to the closest feature layer in the network gets calculated.

getSourceIDField

public Object getSourceIDField()
Returns the Source ID field parameter of this tool . This parameter is Field, name of the field to be created or updated with the source ID of the computed network location. This is an optional parameter.

Returns:
the Source ID field

setSourceIDField

public void setSourceIDField(Object sourceIDField)
Sets the Source ID field parameter of this tool . This parameter is Field, name of the field to be created or updated with the source ID of the computed network location. This is an optional parameter.

Parameters:
sourceIDField - Field, name of the field to be created or updated with the source ID of the computed network location.

getSourceOIDField

public Object getSourceOIDField()
Returns the Source OID field parameter of this tool . This parameter is Field, name of the field to be created or updated with the source OID of the computed network location. This is an optional parameter.

Returns:
the Source OID field

setSourceOIDField

public void setSourceOIDField(Object sourceOIDField)
Sets the Source OID field parameter of this tool . This parameter is Field, name of the field to be created or updated with the source OID of the computed network location. This is an optional parameter.

Parameters:
sourceOIDField - Field, name of the field to be created or updated with the source OID of the computed network location.

getPositionField

public Object getPositionField()
Returns the Percent along field parameter of this tool . This parameter is Field, name of the field to be created or updated with the percent along of the computed network location. This is an optional parameter.

Returns:
the Percent along field

setPositionField

public void setPositionField(Object positionField)
Sets the Percent along field parameter of this tool . This parameter is Field, name of the field to be created or updated with the percent along of the computed network location. This is an optional parameter.

Parameters:
positionField - Field, name of the field to be created or updated with the percent along of the computed network location.

getSideField

public Object getSideField()
Returns the Side of edge field parameter of this tool . This parameter is Field, name of the field to be created or updated with the side of edge on which the point feature is located on the computed network location. This is an optional parameter.

Returns:
the Side of edge field

setSideField

public void setSideField(Object sideField)
Sets the Side of edge field parameter of this tool . This parameter is Field, name of the field to be created or updated with the side of edge on which the point feature is located on the computed network location. This is an optional parameter.

Parameters:
sideField - Field, name of the field to be created or updated with the side of edge on which the point feature is located on the computed network location.

getSnapXField

public Object getSnapXField()
Returns the Located X-coordinate field parameter of this tool . This is an optional parameter.

Returns:
the Located X-coordinate field

setSnapXField

public void setSnapXField(Object snapXField)
Sets the Located X-coordinate field parameter of this tool . This is an optional parameter.

Parameters:
snapXField - null

getSnapYField

public Object getSnapYField()
Returns the Located Y-coordinate field parameter of this tool . This is an optional parameter.

Returns:
the Located Y-coordinate field

setSnapYField

public void setSnapYField(Object snapYField)
Sets the Located Y-coordinate field parameter of this tool . This is an optional parameter.

Parameters:
snapYField - null

getDistanceField

public Object getDistanceField()
Returns the Distance from feature field parameter of this tool . This parameter is Field, name of the field to be created or updated with the distance of the point feature from the computed network location. This is an optional parameter.

Returns:
the Distance from feature field

setDistanceField

public void setDistanceField(Object distanceField)
Sets the Distance from feature field parameter of this tool . This parameter is Field, name of the field to be created or updated with the distance of the point feature from the computed network location. This is an optional parameter.

Parameters:
distanceField - Field, name of the field to be created or updated with the distance of the point feature from the computed network location.

getOutPointFeatureClass

public Object getOutPointFeatureClass()
Returns the Output derived point feature class parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output derived point feature class

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