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

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

public class StandardDistance
extends AbstractGPTool

Measures the degree to which features are concentrated or dispersed around the geometric mean center. The Standard Distance tool is contained in the Spatial Statistics Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
StandardDistance()
          Creates the Standard Distance tool with defaults.
StandardDistance(Object inputFeatureClass, Object outputStandardDistanceFeatureClass, String circleSize)
          Creates the Standard Distance tool with the required parameters.
 
Method Summary
 Object getCaseField()
          Returns the Case Field parameter of this tool .
 String getCircleSize()
          Returns the Circle Size parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 Object getOutputStandardDistanceFeatureClass()
          Returns the Output Standard Distance 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.
 Object getWeightField()
          Returns the Weight Field parameter of this tool .
 void setCaseField(Object caseField)
          Sets the Case Field parameter of this tool .
 void setCircleSize(String circleSize)
          Sets the Circle Size parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setOutputStandardDistanceFeatureClass(Object outputStandardDistanceFeatureClass)
          Sets the Output Standard Distance Feature Class parameter of this tool .
 void setWeightField(Object weightField)
          Sets the Weight 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

StandardDistance

public StandardDistance()
Creates the Standard Distance tool with defaults.

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


StandardDistance

public StandardDistance(Object inputFeatureClass,
                        Object outputStandardDistanceFeatureClass,
                        String circleSize)
Creates the Standard Distance 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:
inputFeatureClass - a feature class containing a distribution of features for which the standard distance will be calculated.
outputStandardDistanceFeatureClass - a polygon feature class that will contain a circle polygon for each input center. These circle polygons graphically portray the standard distance at each center point.
circleSize - the size of output circles in standard deviations. The default circle size is 1; valid choices are 1, 2, or 3 standard deviations.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is a feature class containing a distribution of features for which the standard distance will be calculated. This is a required parameter.

Returns:
the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(Object inputFeatureClass)
Sets the Input Feature Class parameter of this tool . This parameter is a feature class containing a distribution of features for which the standard distance will be calculated. This is a required parameter.

Parameters:
inputFeatureClass - a feature class containing a distribution of features for which the standard distance will be calculated.

getOutputStandardDistanceFeatureClass

public Object getOutputStandardDistanceFeatureClass()
Returns the Output Standard Distance Feature Class parameter of this tool . This parameter is a polygon feature class that will contain a circle polygon for each input center. These circle polygons graphically portray the standard distance at each center point. This is a required parameter.

Returns:
the Output Standard Distance Feature Class

setOutputStandardDistanceFeatureClass

public void setOutputStandardDistanceFeatureClass(Object outputStandardDistanceFeatureClass)
Sets the Output Standard Distance Feature Class parameter of this tool . This parameter is a polygon feature class that will contain a circle polygon for each input center. These circle polygons graphically portray the standard distance at each center point. This is a required parameter.

Parameters:
outputStandardDistanceFeatureClass - a polygon feature class that will contain a circle polygon for each input center. These circle polygons graphically portray the standard distance at each center point.

getCircleSize

public String getCircleSize()
Returns the Circle Size parameter of this tool . This parameter is the size of output circles in standard deviations. The default circle size is 1; valid choices are 1, 2, or 3 standard deviations. This is a required parameter.

Returns:
the Circle Size

setCircleSize

public void setCircleSize(String circleSize)
Sets the Circle Size parameter of this tool . This parameter is the size of output circles in standard deviations. The default circle size is 1; valid choices are 1, 2, or 3 standard deviations. This is a required parameter.

Parameters:
circleSize - the size of output circles in standard deviations. The default circle size is 1; valid choices are 1, 2, or 3 standard deviations.

getWeightField

public Object getWeightField()
Returns the Weight Field parameter of this tool . This parameter is the numeric field used to weight locations according to their relative importance. This is an optional parameter.

Returns:
the Weight Field

setWeightField

public void setWeightField(Object weightField)
Sets the Weight Field parameter of this tool . This parameter is the numeric field used to weight locations according to their relative importance. This is an optional parameter.

Parameters:
weightField - the numeric field used to weight locations according to their relative importance.

getCaseField

public Object getCaseField()
Returns the Case Field parameter of this tool . This parameter is field used to group features for separate standard distance calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Returns:
the Case Field

setCaseField

public void setCaseField(Object caseField)
Sets the Case Field parameter of this tool . This parameter is field used to group features for separate standard distance calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Parameters:
caseField - field used to group features for separate standard distance calculations. The case field can be of numeric, date, or string type.

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