com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CalculateDefaultGridIndex

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

public class CalculateDefaultGridIndex
extends AbstractGPTool

This tool will calculate a set of valid grid index values for an input feature class. This is independent of whether or not the input feature class supports spatial grid indexing. The Calculate Default Spatial Grid Index. tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CalculateDefaultGridIndex()
          Creates the Calculate Default Spatial Grid Index.
CalculateDefaultGridIndex(Object inFeatures)
          Creates the Calculate Default Spatial Grid Index.
 
Method Summary
 double getGridIndex1()
          Returns the Spatial Grid Index parameter of this tool (Read only).
 double getGridIndex2()
          Returns the Spatial Grid Index2 parameter of this tool (Read only).
 double getGridIndex3()
          Returns the Spatial Grid Index3 parameter of this tool (Read only).
 Object getInFeatures()
          Returns the Input Features 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 setInFeatures(Object inFeatures)
          Sets the Input Features 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

CalculateDefaultGridIndex

public CalculateDefaultGridIndex()
Creates the Calculate Default Spatial Grid Index. tool with defaults.

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


CalculateDefaultGridIndex

public CalculateDefaultGridIndex(Object inFeatures)
Creates the Calculate Default Spatial Grid Index. 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 features for which a spatial grid index sizes will be calculated.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input Features parameter of this tool . This parameter is Feature Layer, the features for which a spatial grid index sizes will be calculated. 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 features for which a spatial grid index sizes will be calculated. This is a required parameter.

Parameters:
inFeatures - Feature Layer, the features for which a spatial grid index sizes will be calculated.

getGridIndex1

public double getGridIndex1()
Returns the Spatial Grid Index parameter of this tool (Read only). This is an derived parameter.

Returns:
the Spatial Grid Index

getGridIndex2

public double getGridIndex2()
Returns the Spatial Grid Index2 parameter of this tool (Read only). This is an derived parameter.

Returns:
the Spatial Grid Index2

getGridIndex3

public double getGridIndex3()
Returns the Spatial Grid Index3 parameter of this tool (Read only). This is an derived parameter.

Returns:
the Spatial Grid Index3

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