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

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

All Implemented Interfaces:

GPTool

public class AddTerrainPoints
extends AbstractGPTool

Adds multipoints to an embedded terrain feature class by appending them or by using them to replace existing multipoints that fall within the same extent. The Add Terrain Points tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• This tool adds multipoints to a feature class embedded in a terrain. The terrain and the embedded feature class must already exist.
• Only multipoints can be embedded in a terrain. Therefore, the input feature class must be of type multipoint.
• This tool performs two types of operations: APPEND and REPLACE. Use the method argument to indicate which mode of operation you want to use.
• Either operation uses a rectangular Area Of Interest (AOI). By default, the AOI is equal to the extent of the input feature class. The Geoprocessing Environment can be used to define a specific extent if a subset of the input feature class is desired. In the case of APPEND, the vertices of the input feature class that fall within the AOI will be added. REPLACE works in two phases. First, vertices of the embedded feature class that fall within the AOI are deleted. Then, those within the AOI of the source feature class are added. If a multipoint crosses the AOI boundary only those vertices within the boundary are operated on.
• If you want to add points to a regular feature class, potentially referenced by a terrain but not embedded in it, use the Append tool.
• Add Terrain Points looks for an existing edit session to piggy-back on. This supports undo if the edit session was initialized to support undo (e.g., using the Editor inside ArcMap™). If there's no edit session, it starts and stops one itself, in which case there is no chance for an undo.
• In order to use this tool on a terrain inside an SDE™ database, the terrain needs to be registered as versioned. You do this by registering the feature dataset the terrain lives in as versioned.
• Adding points to an embedded feature class will invalidate the terrain. Run after adding points.

Field Summary

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

vals

Constructor Summary

AddTerrainPoints()
Creates the Add Terrain Points tool with defaults.

AddTerrainPoints(Object inTerrain, String terrainFeatureClass, Object inFeatureClass)
Creates the Add Terrain Points tool with the required parameters.

Method Summary

Object	getDerivedOutTerrain() Returns the Output Terrain parameter of this tool (Read only).
Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInTerrain() Returns the Input Terrain parameter of this tool .
String	getMethod() Returns the Method parameter of this tool .
String	getTerrainFeatureClass() Returns the Input Terrain 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	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInTerrain(Object inTerrain) Sets the Input Terrain parameter of this tool .
void	setMethod(String method) Sets the Method parameter of this tool .
void	setTerrainFeatureClass(String terrainFeatureClass) Sets the Input Terrain 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

AddTerrainPoints

public AddTerrainPoints()

Creates the Add Terrain Points tool with defaults.

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

AddTerrainPoints

public AddTerrainPoints(Object inTerrain,
                        String terrainFeatureClass,
                        Object inFeatureClass)

Creates the Add 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.

terrainFeatureClass - the embedded feature class to which points will be added.

inFeatureClass - the feature class containing the points to be added.

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.

getTerrainFeatureClass

public String getTerrainFeatureClass()

Returns the Input Terrain Feature Class parameter of this tool . This parameter is the embedded feature class to which points will be added. This is a required parameter.

Returns:

the Input Terrain Feature Class

setTerrainFeatureClass

public void setTerrainFeatureClass(String terrainFeatureClass)

Sets the Input Terrain Feature Class parameter of this tool . This parameter is the embedded feature class to which points will be added. This is a required parameter.

Parameters:

terrainFeatureClass - the embedded feature class to which points will be added.

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the feature class containing the points to be added. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the feature class containing the points to be added. This is a required parameter.

Parameters:

inFeatureClass - the feature class containing the points to be added.

getMethod

public String getMethod()

Returns the Method parameter of this tool . This parameter is indicates whether points are appended to the target or used to replace those in the target. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(String method)

Sets the Method parameter of this tool . This parameter is indicates whether points are appended to the target or used to replace those in the target. This is an optional parameter.

Parameters:

method - indicates whether points are appended to the target or used to replace those in the target.

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