com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class CollectEvents

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

public class CollectEvents
extends AbstractGPTool

Converts event data, such as crimes or disease incidents, to weighted point data The Collect Events tool is contained in the Spatial Statistics Tools tool box.
Learn more about how Collect Events works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CollectEvents()
          Creates the Collect Events tool with defaults.
CollectEvents(Object inputIncidentFeatures, Object outputWeightedPointFeatureClass)
          Creates the Collect Events tool with the required parameters.
 
Method Summary
 Object getInputIncidentFeatures()
          Returns the Input Incident Features parameter of this tool .
 Object getOutputWeightedPointFeatureClass()
          Returns the Output Weighted Point Feature Class parameter of this tool .
 Object getResultsField()
          Returns the Results Field parameter of this tool (Read only).
 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.
 double getZMaxValue()
          Returns the Z Max Value parameter of this tool (Read only).
 void setInputIncidentFeatures(Object inputIncidentFeatures)
          Sets the Input Incident Features parameter of this tool .
 void setOutputWeightedPointFeatureClass(Object outputWeightedPointFeatureClass)
          Sets the Output Weighted Point 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

CollectEvents

public CollectEvents()
Creates the Collect Events tool with defaults.

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


CollectEvents

public CollectEvents(Object inputIncidentFeatures,
                     Object outputWeightedPointFeatureClass)
Creates the Collect Events 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:
inputIncidentFeatures - Feature Class, the features representing event or incident data.
outputWeightedPointFeatureClass - Feature Class, the output feature class to contain the weighted point data.
Method Detail

getInputIncidentFeatures

public Object getInputIncidentFeatures()
Returns the Input Incident Features parameter of this tool . This parameter is Feature Class, the features representing event or incident data. This is a required parameter.

Returns:
the Input Incident Features

setInputIncidentFeatures

public void setInputIncidentFeatures(Object inputIncidentFeatures)
Sets the Input Incident Features parameter of this tool . This parameter is Feature Class, the features representing event or incident data. This is a required parameter.

Parameters:
inputIncidentFeatures - Feature Class, the features representing event or incident data.

getOutputWeightedPointFeatureClass

public Object getOutputWeightedPointFeatureClass()
Returns the Output Weighted Point Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to contain the weighted point data. This is a required parameter.

Returns:
the Output Weighted Point Feature Class

setOutputWeightedPointFeatureClass

public void setOutputWeightedPointFeatureClass(Object outputWeightedPointFeatureClass)
Sets the Output Weighted Point Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to contain the weighted point data. This is a required parameter.

Parameters:
outputWeightedPointFeatureClass - Feature Class, the output feature class to contain the weighted point data.

getResultsField

public Object getResultsField()
Returns the Results Field parameter of this tool (Read only). This is an derived parameter.

Returns:
the Results Field

getZMaxValue

public double getZMaxValue()
Returns the Z Max Value parameter of this tool (Read only). This is an derived parameter.

Returns:
the Z Max Value

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