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

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

public class RemoveTerrainPyramidLevel
extends AbstractGPTool

This tool removes a pyramid level from a terrain dataset. The Remove Terrain Pyramid Level tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
RemoveTerrainPyramidLevel()
          Creates the Remove Terrain Pyramid Level tool with defaults.
RemoveTerrainPyramidLevel(Object inTerrain, double pyramidLevelResolution)
          Creates the Remove Terrain Pyramid Level 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 .
 double getPyramidLevelResolution()
          Returns the Pyramid Level Resolution 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 .
 void setPyramidLevelResolution(double pyramidLevelResolution)
          Sets the Pyramid Level Resolution 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

RemoveTerrainPyramidLevel

public RemoveTerrainPyramidLevel()
Creates the Remove Terrain Pyramid Level tool with defaults.

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


RemoveTerrainPyramidLevel

public RemoveTerrainPyramidLevel(Object inTerrain,
                                 double pyramidLevelResolution)
Creates the Remove Terrain Pyramid Level 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.
pyramidLevelResolution - the pyramid level to be removed as specified by its resolution.
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.

getPyramidLevelResolution

public double getPyramidLevelResolution()
Returns the Pyramid Level Resolution parameter of this tool . This parameter is the pyramid level to be removed as specified by its resolution. This is a required parameter.

Returns:
the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)
Sets the Pyramid Level Resolution parameter of this tool . This parameter is the pyramid level to be removed as specified by its resolution. This is a required parameter.

Parameters:
pyramidLevelResolution - the pyramid level to be removed as specified by its resolution.

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