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

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

public class AddTerrainPyramidLevel
extends AbstractGPTool

Adds new pyramid level(s) to an existing terrain dataset. The Add Terrain Pyramid Level tool is contained in the 3D Analyst Tools tool box.
Learn more about how Terrain Pyramid Level Definition (3D Analyst) works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AddTerrainPyramidLevel()
          Creates the Add Terrain Pyramid Level tool with defaults.
AddTerrainPyramidLevel(Object inTerrain, Object pyramidLevelDefinition)
          Creates the Add 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 .
 Object getPyramidLevelDefinition()
          Returns the Pyramid Levels Definition parameter of this tool .
 String getPyramidType()
          Returns the Pyramid Type 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 setPyramidLevelDefinition(Object pyramidLevelDefinition)
          Sets the Pyramid Levels Definition parameter of this tool .
 void setPyramidType(String pyramidType)
          Sets the Pyramid Type 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

AddTerrainPyramidLevel

public AddTerrainPyramidLevel()
Creates the Add Terrain Pyramid Level tool with defaults.

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


AddTerrainPyramidLevel

public AddTerrainPyramidLevel(Object inTerrain,
                              Object pyramidLevelDefinition)
Creates the Add 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 - Terrain Layer, the terrain to which you want to add a pyramid level.
pyramidLevelDefinition - String, the z-tolerance or window size and reference scale of one or more pyramid levels that will be added to the terrain. The values are given in space delimited pairs; one pair for each level. The pyramid type (z-tolerance or window size) can be specified as a floating point value. The reference scale must be provided as a whole number (e.g. a value of 24000 represents a scale of 1:24000).
Method Detail

getInTerrain

public Object getInTerrain()
Returns the Input Terrain parameter of this tool . This parameter is Terrain Layer, the terrain to which you want to add a pyramid level. 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 to which you want to add a pyramid level. This is a required parameter.

Parameters:
inTerrain - Terrain Layer, the terrain to which you want to add a pyramid level.

getPyramidType

public String getPyramidType()
Returns the Pyramid Type parameter of this tool . This parameter is String, the type of pyramid methodology. This parameter has no value with ArcGIS 9.3 and may be omitted. The purpose of this parameter at ArcGIS 9.3 is to ensure compatibility with scripts and models written using ArcGIS 9.2. This is an optional parameter.

Returns:
the Pyramid Type

setPyramidType

public void setPyramidType(String pyramidType)
Sets the Pyramid Type parameter of this tool . This parameter is String, the type of pyramid methodology. This parameter has no value with ArcGIS 9.3 and may be omitted. The purpose of this parameter at ArcGIS 9.3 is to ensure compatibility with scripts and models written using ArcGIS 9.2. This is an optional parameter.

Parameters:
pyramidType - String, the type of pyramid methodology. This parameter has no value with ArcGIS 9.3 and may be omitted. The purpose of this parameter at ArcGIS 9.3 is to ensure compatibility with scripts and models written using ArcGIS 9.2.

getPyramidLevelDefinition

public Object getPyramidLevelDefinition()
Returns the Pyramid Levels Definition parameter of this tool . This parameter is String, the z-tolerance or window size and reference scale of one or more pyramid levels that will be added to the terrain. The values are given in space delimited pairs; one pair for each level. The pyramid type (z-tolerance or window size) can be specified as a floating point value. The reference scale must be provided as a whole number (e.g. a value of 24000 represents a scale of 1:24000). This is a required parameter.

Returns:
the Pyramid Levels Definition

setPyramidLevelDefinition

public void setPyramidLevelDefinition(Object pyramidLevelDefinition)
Sets the Pyramid Levels Definition parameter of this tool . This parameter is String, the z-tolerance or window size and reference scale of one or more pyramid levels that will be added to the terrain. The values are given in space delimited pairs; one pair for each level. The pyramid type (z-tolerance or window size) can be specified as a floating point value. The reference scale must be provided as a whole number (e.g. a value of 24000 represents a scale of 1:24000). This is a required parameter.

Parameters:
pyramidLevelDefinition - String, the z-tolerance or window size and reference scale of one or more pyramid levels that will be added to the terrain. The values are given in space delimited pairs; one pair for each level. The pyramid type (z-tolerance or window size) can be specified as a floating point value. The reference scale must be provided as a whole number (e.g. a value of 24000 represents a scale of 1:24000).

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