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

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

public class BatchBuildPyramids
extends AbstractGPTool

Builds pyramids for multiple raster datasets. The Batch Build Pyramids tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
BatchBuildPyramids()
          Creates the Batch Build Pyramids tool with defaults.
BatchBuildPyramids(Object inputRasterDatasets)
          Creates the Batch Build Pyramids tool with the required parameters.
 
Method Summary
 String getBatchBuildPyramidsSucceeded()
          Returns the Batch Build Pyramids Succeeded parameter of this tool (Read only).
 Object getInputRasterDatasets()
          Returns the Input Raster Datasets 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 setInputRasterDatasets(Object inputRasterDatasets)
          Sets the Input Raster Datasets 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

BatchBuildPyramids

public BatchBuildPyramids()
Creates the Batch Build Pyramids tool with defaults.

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


BatchBuildPyramids

public BatchBuildPyramids(Object inputRasterDatasets)
Creates the Batch 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:
inputRasterDatasets - Raster dataset, the input raster datasets that you want to build raster pyramids for.
Method Detail

getInputRasterDatasets

public Object getInputRasterDatasets()
Returns the Input Raster Datasets parameter of this tool . This parameter is Raster dataset, the input raster datasets that you want to build raster pyramids for. This is a required parameter.

Returns:
the Input Raster Datasets

setInputRasterDatasets

public void setInputRasterDatasets(Object inputRasterDatasets)
Sets the Input Raster Datasets parameter of this tool . This parameter is Raster dataset, the input raster datasets that you want to build raster pyramids for. This is a required parameter.

Parameters:
inputRasterDatasets - Raster dataset, the input raster datasets that you want to build raster pyramids for.

getBatchBuildPyramidsSucceeded

public String getBatchBuildPyramidsSucceeded()
Returns the Batch Build Pyramids Succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:
the Batch Build Pyramids Succeeded

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