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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.

Software restrictions: none

Usage tips:


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 - Terrain Layer, the terrain dataset to be modified.
terrainFeatureClass - String, the embedded feature class to which points will be added.
inFeatureClass - Feature Layer, 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 Terrain Layer, 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 Terrain Layer, the terrain dataset to be modified. This is a required parameter.

Parameters:
inTerrain - Terrain Layer, the terrain dataset to be modified.

getTerrainFeatureClass

public String getTerrainFeatureClass()
Returns the Input Terrain Feature Class parameter of this tool . This parameter is String, 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 String, the embedded feature class to which points will be added. This is a required parameter.

Parameters:
terrainFeatureClass - String, 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 Feature Layer, 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 Feature Layer, the feature class containing the points to be added. This is a required parameter.

Parameters:
inFeatureClass - Feature Layer, the feature class containing the points to be added.

getMethod

public String getMethod()
Returns the Method parameter of this tool . This parameter is String, 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 String, indicates whether points are appended to the target or used to replace those in the target. This is an optional parameter.

Parameters:
method - String, 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