com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class DeleteTerrainPoints

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

public class DeleteTerrainPoints
extends AbstractGPTool

Deletes points from a terrain dataset within an area of interest from one or more feature classes. The Delete Terrain Points tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
DeleteTerrainPoints()
          Creates the Delete Terrain Points tool with defaults.
DeleteTerrainPoints(Object inTerrain, Object dataSource, Object polygonFeaturesOrExtent)
          Creates the Delete Terrain Points tool with the required parameters.
 
Method Summary
 Object getDataSource()
          Returns the Input Terrain Data Source parameter of this tool .
 Object getDerivedOutTerrain()
          Returns the Output Terrain parameter of this tool (Read only).
 Object getInTerrain()
          Returns the Input Terrain parameter of this tool .
 Object getPolygonFeaturesOrExtent()
          Returns the Area of Interest 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 setDataSource(Object dataSource)
          Sets the Input Terrain Data Source parameter of this tool .
 void setInTerrain(Object inTerrain)
          Sets the Input Terrain parameter of this tool .
 void setPolygonFeaturesOrExtent(Object polygonFeaturesOrExtent)
          Sets the Area of Interest 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

DeleteTerrainPoints

public DeleteTerrainPoints()
Creates the Delete Terrain Points tool with defaults.

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


DeleteTerrainPoints

public DeleteTerrainPoints(Object inTerrain,
                           Object dataSource,
                           Object polygonFeaturesOrExtent)
Creates the Delete Terrain Points 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:
inTerrain - the terrain dataset to be modified.
dataSource - one or more feature classes from which points will be removed.
polygonFeaturesOrExtent - the location defining the area from which points will be removed.
Method Detail

getInTerrain

public Object getInTerrain()
Returns the Input Terrain parameter of this tool . This parameter is the terrain dataset to be modified. This is a required parameter.

Returns:
the Input Terrain

setInTerrain

public void setInTerrain(Object inTerrain)
Sets the Input Terrain parameter of this tool . This parameter is the terrain dataset to be modified. This is a required parameter.

Parameters:
inTerrain - the terrain dataset to be modified.

getDataSource

public Object getDataSource()
Returns the Input Terrain Data Source parameter of this tool . This parameter is one or more feature classes from which points will be removed. This is a required parameter.

Returns:
the Input Terrain Data Source

setDataSource

public void setDataSource(Object dataSource)
Sets the Input Terrain Data Source parameter of this tool . This parameter is one or more feature classes from which points will be removed. This is a required parameter.

Parameters:
dataSource - one or more feature classes from which points will be removed.

getPolygonFeaturesOrExtent

public Object getPolygonFeaturesOrExtent()
Returns the Area of Interest parameter of this tool . This parameter is the location defining the area from which points will be removed. This is a required parameter.

Returns:
the Area of Interest

setPolygonFeaturesOrExtent

public void setPolygonFeaturesOrExtent(Object polygonFeaturesOrExtent)
Sets the Area of Interest parameter of this tool . This parameter is the location defining the area from which points will be removed. This is a required parameter.

Parameters:
polygonFeaturesOrExtent - the location defining the area from which points will be removed.

getDerivedOutTerrain

public Object getDerivedOutTerrain()
Returns the Output Terrain parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Terrain

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