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

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

public class CollectEventsRendered
extends AbstractGPTool

Converts event data to weighted point data and applies a graduated circle rendering to the count field. The Collect Events with Rendering tool is contained in the Spatial Statistics Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CollectEventsRendered()
          Creates the Collect Events with Rendering tool with defaults.
CollectEventsRendered(Object inputIncidentFeatures, Object outputLayerFile, Object outputWeightedPointFeatureClass)
          Creates the Collect Events with Rendering tool with the required parameters.
 
Method Summary
 Object getInputIncidentFeatures()
          Returns the Input Incident Features parameter of this tool .
 Object getOutputLayerFile()
          Returns the Output Layer File parameter of this tool .
 Object getOutputWeightedPointFeatureClass()
          Returns the Output Weighted Point 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 setInputIncidentFeatures(Object inputIncidentFeatures)
          Sets the Input Incident Features parameter of this tool .
 void setOutputLayerFile(Object outputLayerFile)
          Sets the Output Layer File 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

CollectEventsRendered

public CollectEventsRendered()
Creates the Collect Events with Rendering tool with defaults.

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


CollectEventsRendered

public CollectEventsRendered(Object inputIncidentFeatures,
                             Object outputLayerFile,
                             Object outputWeightedPointFeatureClass)
Creates the Collect Events with Rendering 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.
outputLayerFile - Layer File, the layer file to store the graduate circle rendering information. You must include the .lyr extension as part of the file name.
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.

getOutputLayerFile

public Object getOutputLayerFile()
Returns the Output Layer File parameter of this tool . This parameter is Layer File, the layer file to store the graduate circle rendering information. You must include the .lyr extension as part of the file name. This is a required parameter.

Returns:
the Output Layer File

setOutputLayerFile

public void setOutputLayerFile(Object outputLayerFile)
Sets the Output Layer File parameter of this tool . This parameter is Layer File, the layer file to store the graduate circle rendering information. You must include the .lyr extension as part of the file name. This is a required parameter.

Parameters:
outputLayerFile - Layer File, the layer file to store the graduate circle rendering information. You must include the .lyr extension as part of the file name.

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.

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