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

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

public class ExtractSubDataset
extends AbstractGPTool

Extracts raster datasets stored within a subdataset raster file. The Extract Subdataset 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
ExtractSubDataset()
          Creates the Extract Subdataset tool with defaults.
ExtractSubDataset(Object inRaster, Object outRaster)
          Creates the Extract Subdataset tool with the required parameters.
 
Method Summary
 Object getInRaster()
          Returns the Input Raster parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster parameter of this tool .
 Object getSubdatasetIndex()
          Returns the Subdataset ID 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 setInRaster(Object inRaster)
          Sets the Input Raster parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output Raster parameter of this tool .
 void setSubdatasetIndex(Object subdatasetIndex)
          Sets the Subdataset ID 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

ExtractSubDataset

public ExtractSubDataset()
Creates the Extract Subdataset tool with defaults.

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


ExtractSubDataset

public ExtractSubDataset(Object inRaster,
                         Object outRaster)
Creates the Extract Subdataset 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:
inRaster - Raster dataset, the input subdataset raster format. Valid inputs can either be HDF or NITF files.
outRaster - Raster dataset, when storing your raster dataset to a geodatabase you, can specify a compression type.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input Raster parameter of this tool . This parameter is Raster dataset, the input subdataset raster format. Valid inputs can either be HDF or NITF files. This is a required parameter.

Returns:
the Input Raster

setInRaster

public void setInRaster(Object inRaster)
Sets the Input Raster parameter of this tool . This parameter is Raster dataset, the input subdataset raster format. Valid inputs can either be HDF or NITF files. This is a required parameter.

Parameters:
inRaster - Raster dataset, the input subdataset raster format. Valid inputs can either be HDF or NITF files.

getOutRaster

public Object getOutRaster()
Returns the Output Raster parameter of this tool . This parameter is Raster dataset, when storing your raster dataset to a geodatabase you, can specify a compression type. This is a required parameter.

Returns:
the Output Raster

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output Raster parameter of this tool . This parameter is Raster dataset, when storing your raster dataset to a geodatabase you, can specify a compression type. This is a required parameter.

Parameters:
outRaster - Raster dataset, when storing your raster dataset to a geodatabase you, can specify a compression type.

getSubdatasetIndex

public Object getSubdatasetIndex()
Returns the Subdataset ID parameter of this tool . This parameter is Subdataset, define the subdatasets that you want to extract. This is an optional parameter.

Returns:
the Subdataset ID

setSubdatasetIndex

public void setSubdatasetIndex(Object subdatasetIndex)
Sets the Subdataset ID parameter of this tool . This parameter is Subdataset, define the subdatasets that you want to extract. This is an optional parameter.

Parameters:
subdatasetIndex - Subdataset, define the subdatasets that you want to extract.

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