com.esri.arcgis.geoprocessing.tools.analysistools
Class CreateThiessenPolygons

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

public class CreateThiessenPolygons
extends AbstractGPTool

Converts input points to an output feature class of Thiessen proximal polygons. Thiessen polygons have the unique property that each polygon contains only one input point, and any location within a polygon is closer to its associated point than to the point of any other polygon. The Create Thiessen Polygons tool is contained in the Analysis Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateThiessenPolygons()
          Creates the Create Thiessen Polygons tool with defaults.
CreateThiessenPolygons(Object inFeatures, Object outFeatureClass)
          Creates the Create Thiessen Polygons tool with the required parameters.
 
Method Summary
 String getFieldsToCopy()
          Returns the Output Fields parameter of this tool .
 Object getInFeatures()
          Returns the Input Features parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class 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 setFieldsToCopy(String fieldsToCopy)
          Sets the Output Fields parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class 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

CreateThiessenPolygons

public CreateThiessenPolygons()
Creates the Create Thiessen Polygons tool with defaults.

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


CreateThiessenPolygons

public CreateThiessenPolygons(Object inFeatures,
                              Object outFeatureClass)
Creates the Create Thiessen Polygons 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:
inFeatures - Feature Layer, the points for which the Thiessen polygons will be generated.
outFeatureClass - Feature Class, the polygon feature class that will contain the Thiessen features.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the points for which the Thiessen polygons will be generated. This is a required parameter.

Returns:
the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input Features parameter of this tool . This parameter is Feature Layer, the points for which the Thiessen polygons will be generated. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the points for which the Thiessen polygons will be generated.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the polygon feature class that will contain the Thiessen features. This is a required parameter.

Returns:
the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the polygon feature class that will contain the Thiessen features. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the polygon feature class that will contain the Thiessen features.

getFieldsToCopy

public String getFieldsToCopy()
Returns the Output Fields parameter of this tool . This parameter is String, determines which attributes from the Input Features will be transferred to the Output Feature Class. This is an optional parameter.

Returns:
the Output Fields

setFieldsToCopy

public void setFieldsToCopy(String fieldsToCopy)
Sets the Output Fields parameter of this tool . This parameter is String, determines which attributes from the Input Features will be transferred to the Output Feature Class. This is an optional parameter.

Parameters:
fieldsToCopy - String, determines which attributes from the Input Features will be transferred to the Output 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