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

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

All Implemented Interfaces:

GPTool

public class ChangeTerrainResolutionBounds
extends AbstractGPTool

Changes the pyramid level resolution bounds for a given feature class contributing to the surface of the terrain dataset. The Change Terrain Resolution Bounds tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• This tool is useful when an existing feature class of a terrain dataset has inappropriate resolution bounds that need to be reset.
• A rebuild of the terrain dataset is not required for these changes to be implemented.

Field Summary

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

vals

Constructor Summary

ChangeTerrainResolutionBounds()
Creates the Change Terrain Resolution Bounds tool with defaults.

ChangeTerrainResolutionBounds(Object inTerrain, String featureClass, double lowerPyramidResolution, double upperPyramidResolution)
Creates the Change Terrain Resolution Bounds 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 .
double	getLowerPyramidResolution() Returns the Lower Pyramid Resolution parameter of this tool .
String	getOverview() Returns the Contributes to Overview 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.
double	getUpperPyramidResolution() Returns the Upper Pyramid Resolution parameter 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 .
void	setLowerPyramidResolution(double lowerPyramidResolution) Sets the Lower Pyramid Resolution parameter of this tool .
void	setOverview(String overview) Sets the Contributes to Overview parameter of this tool .
void	setUpperPyramidResolution(double upperPyramidResolution) Sets the Upper Pyramid 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

ChangeTerrainResolutionBounds

public ChangeTerrainResolutionBounds()

Creates the Change Terrain Resolution Bounds tool with defaults.

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

ChangeTerrainResolutionBounds

public ChangeTerrainResolutionBounds(Object inTerrain,
                                     String featureClass,
                                     double lowerPyramidResolution,
                                     double upperPyramidResolution)

Creates the Change Terrain Resolution Bounds 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 input terrain dataset.

featureClass - the input Feature Class which requires that the current pyramid level resolutions be modified.

lowerPyramidResolution - the new lower pyramid level resolution for the chosen feature class.

upperPyramidResolution - the new upper pyramid level resolution for the chosen feature class.

Method Detail

getInTerrain

public Object getInTerrain()

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

Parameters:

inTerrain - the input terrain dataset.

getFeatureClass

public String getFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input Feature Class which requires that the current pyramid level resolutions be modified. 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 input Feature Class which requires that the current pyramid level resolutions be modified. This is a required parameter.

Parameters:

featureClass - the input Feature Class which requires that the current pyramid level resolutions be modified.

getLowerPyramidResolution

public double getLowerPyramidResolution()

Returns the Lower Pyramid Resolution parameter of this tool . This parameter is the new lower pyramid level resolution for the chosen feature class. This is a required parameter.

Returns:

the Lower Pyramid Resolution

setLowerPyramidResolution

public void setLowerPyramidResolution(double lowerPyramidResolution)

Sets the Lower Pyramid Resolution parameter of this tool . This parameter is the new lower pyramid level resolution for the chosen feature class. This is a required parameter.

Parameters:

lowerPyramidResolution - the new lower pyramid level resolution for the chosen feature class.

getUpperPyramidResolution

public double getUpperPyramidResolution()

Returns the Upper Pyramid Resolution parameter of this tool . This parameter is the new upper pyramid level resolution for the chosen feature class. This is a required parameter.

Returns:

the Upper Pyramid Resolution

setUpperPyramidResolution

public void setUpperPyramidResolution(double upperPyramidResolution)

Sets the Upper Pyramid Resolution parameter of this tool . This parameter is the new upper pyramid level resolution for the chosen feature class. This is a required parameter.

Parameters:

upperPyramidResolution - the new upper pyramid level resolution for the chosen feature class.

getOverview

public String getOverview()

Returns the Contributes to Overview parameter of this tool . This parameter is determines if the given feature class will contribute to the overview terrain dataset. This is an optional parameter.

Returns:

the Contributes to Overview

setOverview

public void setOverview(String overview)

Sets the Contributes to Overview parameter of this tool . This parameter is determines if the given feature class will contribute to the overview terrain dataset. This is an optional parameter.

Parameters:

overview - determines if the given feature class will contribute to the overview terrain dataset.

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