com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class BuildPyramids

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

public class BuildPyramids
extends AbstractGPTool

Builds raster pyramids for a raster dataset. The Build Pyramids tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
BuildPyramids()
          Creates the Build Pyramids tool with defaults.
BuildPyramids(Object inRasterDataset)
          Creates the Build Pyramids tool with the required parameters.
 
Method Summary
 Object getInRasterDataset()
          Returns the Input Raster Dataset parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster Dataset parameter of this tool (Read only).
 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 setInRasterDataset(Object inRasterDataset)
          Sets the Input Raster Dataset 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

BuildPyramids

public BuildPyramids()
Creates the Build Pyramids tool with defaults.

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


BuildPyramids

public BuildPyramids(Object inRasterDataset)
Creates the Build Pyramids 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:
inRasterDataset - Raster dataset, the input raster dataset.
Method Detail

getInRasterDataset

public Object getInRasterDataset()
Returns the Input Raster Dataset parameter of this tool . This parameter is Raster dataset, the input raster dataset. This is a required parameter.

Returns:
the Input Raster Dataset

setInRasterDataset

public void setInRasterDataset(Object inRasterDataset)
Sets the Input Raster Dataset parameter of this tool . This parameter is Raster dataset, the input raster dataset. This is a required parameter.

Parameters:
inRasterDataset - Raster dataset, the input raster dataset.

getOutRaster

public Object getOutRaster()
Returns the Output Raster Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Raster Dataset

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