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

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

All Implemented Interfaces:

GPTool

public class RemoveFeatureClassFromTerrain
extends AbstractGPTool

Removes reference to a feature class participating in a terrain dataset. If the feature class is embedded it will be extracted and dereferenced. The Remove Feature Class from Terrain tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• This tool does not delete the feature class. Rather, it eliminates the terrain dataset's reference to it.
• If the feature class is embedded in the terrain it will be extracted and dereferenced.
• The terrain may need to be rebuilt using after using this tool. This depends on how the feature class is used to define the terrain. The terrain dataset's Properties dialog box in ArcCatalog and the terrain layer's Properties dialog box both provide an indication as to whether the dataset needs to be rebuilt.
• When used in an SDE database, the input terrain cannot be registered as versioned.

Field Summary

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

vals

Constructor Summary

RemoveFeatureClassFromTerrain()
Creates the Remove Feature Class from Terrain tool with defaults.

RemoveFeatureClassFromTerrain(Object inTerrain, String featureClass)
Creates the Remove Feature Class from Terrain tool with the required parameters.

Method Summary

Object	getDerivedOutTerrain() Returns the Output Terrain parameter of this tool (Read only).
String	getFeatureClass() Returns the Input Feature Class parameter of this tool .
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	setFeatureClass(String featureClass) Sets the Input Feature Class parameter 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

RemoveFeatureClassFromTerrain

public RemoveFeatureClassFromTerrain()

Creates the Remove Feature Class from Terrain tool with defaults.

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

RemoveFeatureClassFromTerrain

public RemoveFeatureClassFromTerrain(Object inTerrain,
                                     String featureClass)

Creates the Remove Feature Class from 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 modified.

featureClass - the feature class to be removed.

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.

getFeatureClass

public String getFeatureClass()

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

Returns:

the Input Feature Class

setFeatureClass

public void setFeatureClass(String featureClass)

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

Parameters:

featureClass - the feature class to be removed.

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