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

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

All Implemented Interfaces:

GPTool

public class BuildTerrain
extends AbstractGPTool

Performs the necessary steps to make a terrain dataset usable after it's 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.

Usage tips:

• Build Terrain will perform the work necessary to update the terrain relative to any edits. These include modifications to terrain schema (i.e., feature class participation, pyramid definition) or to geometry in associated feature classes. It's more efficient to make a collection of edits followed by one build rather than running a build after each individual edit.

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.
String	getUpdateExtent() Returns the Update Extent parameter of this tool .
void	setInTerrain(Object inTerrain) Sets the Input Terrain parameter of this tool .
void	setUpdateExtent(String updateExtent) Sets the Update Extent 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 - the terrain dataset to be built.

Method Detail

getInTerrain

public Object getInTerrain()

Returns the Input Terrain parameter of this tool . This parameter is 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 the terrain dataset to be built. This is a required parameter.

Parameters:

inTerrain - the terrain dataset to be built.

getUpdateExtent

public String getUpdateExtent()

Returns the Update Extent parameter of this tool . This parameter is update Extent is used to recalculate the data extent for a window size based terrain dataset when the data area has been reduced through editing. It is not needed if the data extent has increased or if the terrain dataset is z-tolerance based. It will scan through all the terrain data to determine the new extent. If the terrain is large it may be expensive in terms of I/O to run this option. This is an optional parameter.

Returns:

the Update Extent

setUpdateExtent

public void setUpdateExtent(String updateExtent)

Sets the Update Extent parameter of this tool . This parameter is update Extent is used to recalculate the data extent for a window size based terrain dataset when the data area has been reduced through editing. It is not needed if the data extent has increased or if the terrain dataset is z-tolerance based. It will scan through all the terrain data to determine the new extent. If the terrain is large it may be expensive in terms of I/O to run this option. This is an optional parameter.

Parameters:

updateExtent - update Extent is used to recalculate the data extent for a window size based terrain dataset when the data area has been reduced through editing. It is not needed if the data extent has increased or if the terrain dataset is z-tolerance based. It will scan through all the terrain data to determine the new extent. If the terrain is large it may be expensive in terms of I/O to run this option.

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