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

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

All Implemented Interfaces:

GPTool

public class AddTerrainPyramidLevel

extends AbstractGPTool

Adds a new pyramid level to an existing terrain dataset. The Add Terrain Pyramid Level tool is contained in the 3D Analyst Tools tool box.

Software restrictions: none

Usage tips:

• Adding a new pyramid level to a terrain invalidates it. Use the Build Terrain; tool after adding a pyramid level.
• 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

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

AddTerrainPyramidLevel(java.lang.Object inTerrain, java.lang.String pyramidType, java.lang.Object pyramidLevelDefinition)
Creates the Add Terrain Pyramid Level tool with the required parameters.

Method Summary

java.lang.Object	getDerivedOutTerrain() Returns the Output Terrain parameter of this tool (Read only).
java.lang.Object	getInTerrain() Returns the Input Terrain parameter of this tool .
java.lang.Object	getPyramidLevelDefinition() Returns the Pyramid Levels Definition parameter of this tool .
java.lang.String	getPyramidType() Returns the Pyramid Type parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setInTerrain(java.lang.Object inTerrain) Sets the Input Terrain parameter of this tool .
void	setPyramidLevelDefinition(java.lang.Object pyramidLevelDefinition) Sets the Pyramid Levels Definition parameter of this tool .
void	setPyramidType(java.lang.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(java.lang.Object inTerrain,
                              java.lang.String pyramidType,
                              java.lang.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.

pyramidType - String, the type of pyramid methodology. If other pyramids already exist in the terrain the new one must be the same type.

pyramidLevelDefinition - String, the z-tolerance 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 z-tolerance 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 java.lang.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(java.lang.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 java.lang.String getPyramidType()

Returns the Pyramid Type parameter of this tool . This parameter is String, the type of pyramid methodology. If other pyramids already exist in the terrain the new one must be the same type. This is a required parameter.

Returns:

the Pyramid Type

setPyramidType

public void setPyramidType(java.lang.String pyramidType)

Sets the Pyramid Type parameter of this tool . This parameter is String, the type of pyramid methodology. If other pyramids already exist in the terrain the new one must be the same type. This is a required parameter.

Parameters:

pyramidType - String, the type of pyramid methodology. If other pyramids already exist in the terrain the new one must be the same type.

getPyramidLevelDefinition

public java.lang.Object getPyramidLevelDefinition()

Returns the Pyramid Levels Definition parameter of this tool . This parameter is String, the z-tolerance 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 z-tolerance 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(java.lang.Object pyramidLevelDefinition)

Sets the Pyramid Levels Definition parameter of this tool . This parameter is String, the z-tolerance 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 z-tolerance 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 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 z-tolerance 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 java.lang.Object getDerivedOutTerrain()

Returns the Output Terrain parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Terrain

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias