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

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

public class BuildTerrain
extends AbstractGPTool

Performs the necessary steps to make a terrain usable after its initially defined. It's also used to bring a terrain up to date after it's been modified. The Build Terrain 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
BuildTerrain()
          Creates the Build Terrain tool with defaults.
BuildTerrain(Object inTerrain)
          Creates the Build Terrain tool with the required parameters.
 
Method Summary
 Object getDerivedOutTerrain()
          Returns the Output Terrain parameter of this tool (Read only).
 Object getInTerrain()
          Returns the Input Terrain 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 setInTerrain(Object inTerrain)
          Sets the Input Terrain 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

BuildTerrain

public BuildTerrain()
Creates the Build Terrain tool with defaults.

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


BuildTerrain

public BuildTerrain(Object inTerrain)
Creates the Build Terrain 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 built.
Method Detail

getInTerrain

public Object getInTerrain()
Returns the Input Terrain parameter of this tool . This parameter is Terrain Layer, the terrain dataset to be built. 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 built. This is a required parameter.

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

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