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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.ReplaceTerrainPoints

All Implemented Interfaces:

GPTool

public class ReplaceTerrainPoints
extends AbstractGPTool

Adds points and multipoints to the collection of data used by the terrain dataset, replacing data that had previously been used. The Replace Terrain Points tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Replacing points in a terrain dataset will invalidate it. Run after adding points or multipoints.
• If the terrain is in SDE it must be registered as versioned.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ReplaceTerrainPoints()
Creates the Replace Terrain Points tool with defaults.

ReplaceTerrainPoints(Object inTerrain, String terrainFeatureClass, Object inPointFeatures)
Creates the Replace Terrain Points tool with the required parameters.

Method Summary

Object	getDerivedOutTerrain() Returns the Output Terrain parameter of this tool (Read only).
Object	getInPointFeatures() Returns the Input Points parameter of this tool .
Object	getInTerrain() Returns the Input Terrain parameter of this tool .
Object	getPolygonFeaturesOrExtent() Returns the Area of Interest parameter of this tool .
String	getTerrainFeatureClass() Returns the Input Terrain Data Source 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	setInPointFeatures(Object inPointFeatures) Sets the Input Points 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 .
void	setTerrainFeatureClass(String terrainFeatureClass) Sets the Input Terrain Data Source 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

ReplaceTerrainPoints

public ReplaceTerrainPoints()

Creates the Replace Terrain Points tool with defaults.

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

ReplaceTerrainPoints

public ReplaceTerrainPoints(Object inTerrain,
                            String terrainFeatureClass,
                            Object inPointFeatures)

Creates the Replace 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 input terrain dataset for which the points or multipoints will be replaced.

terrainFeatureClass - the feature class that contributes to the terrain dataset in which the points or multipoints will be replaced.

inPointFeatures - the feature class of points or multipoints to add as an additional data source to replace current points contributing to the terrain dataset.

Method Detail

getInTerrain

public Object getInTerrain()

Returns the Input Terrain parameter of this tool . This parameter is the input terrain dataset for which the points or multipoints will be replaced. 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 input terrain dataset for which the points or multipoints will be replaced. This is a required parameter.

Parameters:

inTerrain - the input terrain dataset for which the points or multipoints will be replaced.

getTerrainFeatureClass

public String getTerrainFeatureClass()

Returns the Input Terrain Data Source parameter of this tool . This parameter is the feature class that contributes to the terrain dataset in which the points or multipoints will be replaced. This is a required parameter.

Returns:

the Input Terrain Data Source

setTerrainFeatureClass

public void setTerrainFeatureClass(String terrainFeatureClass)

Sets the Input Terrain Data Source parameter of this tool . This parameter is the feature class that contributes to the terrain dataset in which the points or multipoints will be replaced. This is a required parameter.

Parameters:

terrainFeatureClass - the feature class that contributes to the terrain dataset in which the points or multipoints will be replaced.

getInPointFeatures

public Object getInPointFeatures()

Returns the Input Points parameter of this tool . This parameter is the feature class of points or multipoints to add as an additional data source to replace current points contributing to the terrain dataset. This is a required parameter.

Returns:

the Input Points

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input Points parameter of this tool . This parameter is the feature class of points or multipoints to add as an additional data source to replace current points contributing to the terrain dataset. This is a required parameter.

Parameters:

inPointFeatures - the feature class of points or multipoints to add as an additional data source to replace current points contributing to the terrain dataset.

getPolygonFeaturesOrExtent

public Object getPolygonFeaturesOrExtent()

Returns the Area of Interest parameter of this tool . This parameter is the area of interest to use to replace the points or multipoints. The default is blank. This is an optional 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 area of interest to use to replace the points or multipoints. The default is blank. This is an optional parameter.

Parameters:

polygonFeaturesOrExtent - the area of interest to use to replace the points or multipoints. The default is blank.

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