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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.MakeRasterLayer

All Implemented Interfaces:

GPTool

public class MakeRasterLayer
extends AbstractGPTool

Makes a temporary raster layer from a raster dataset or mosaic dataset that will be available to select as a variable while working in the same ArcMap, ArcScene, ArcGlobe, or ArcCatalog session. The Make Raster Layer tool is contained in the Data Management Tools tool box.

Usage tips:

• To make your layer permanent, right-click the layer in the table of contents and click Save As Layer File, or use the .

Field Summary

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

vals

Constructor Summary

MakeRasterLayer()
Creates the Make Raster Layer tool with defaults.

MakeRasterLayer(Object inRaster, Object outRasterlayer)
Creates the Make Raster Layer tool with the required parameters.

Method Summary

Object	getBandIndex() Returns the Bands parameter of this tool .
Object	getEnvelope() Returns the Envelope parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutRasterlayer() Returns the Output raster layer name 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.
Object	getWhereClause() Returns the Where clause parameter of this tool .
void	setBandIndex(Object bandIndex) Sets the Bands parameter of this tool .
void	setEnvelope(Object envelope) Sets the Envelope parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRasterlayer(Object outRasterlayer) Sets the Output raster layer name parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Where clause 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

MakeRasterLayer

public MakeRasterLayer()

Creates the Make Raster Layer tool with defaults.

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

MakeRasterLayer

public MakeRasterLayer(Object inRaster,
                       Object outRasterlayer)

Creates the Make Raster Layer 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 - the path and name of the input raster dataset.

outRasterlayer - the name of the temporary output raster dataset.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the path and name of the input raster dataset. 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 the path and name of the input raster dataset. This is a required parameter.

Parameters:

inRaster - the path and name of the input raster dataset.

getOutRasterlayer

public Object getOutRasterlayer()

Returns the Output raster layer name parameter of this tool . This parameter is the name of the temporary output raster dataset. This is a required parameter.

Returns:

the Output raster layer name

setOutRasterlayer

public void setOutRasterlayer(Object outRasterlayer)

Sets the Output raster layer name parameter of this tool . This parameter is the name of the temporary output raster dataset. This is a required parameter.

Parameters:

outRasterlayer - the name of the temporary output raster dataset.

getWhereClause

public Object getWhereClause()

Returns the Where clause parameter of this tool . This parameter is a query statement using the fields and values of the raster dataset. to add this variable, press F8, or right-click and click Insert Variable. This is an optional parameter.

Returns:

the Where clause

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Where clause parameter of this tool . This parameter is a query statement using the fields and values of the raster dataset. to add this variable, press F8, or right-click and click Insert Variable. This is an optional parameter.

Parameters:

whereClause - a query statement using the fields and values of the raster dataset. to add this variable, press F8, or right-click and click Insert Variable.

getEnvelope

public Object getEnvelope()

Returns the Envelope parameter of this tool . This parameter is using the min x, min y, max x, or max y, you can specify the extents of the raster layer. to add this variable, press F8, or right-click and click Insert Variable. This is an optional parameter.

Returns:

the Envelope

setEnvelope

public void setEnvelope(Object envelope)

Sets the Envelope parameter of this tool . This parameter is using the min x, min y, max x, or max y, you can specify the extents of the raster layer. to add this variable, press F8, or right-click and click Insert Variable. This is an optional parameter.

Parameters:

envelope - using the min x, min y, max x, or max y, you can specify the extents of the raster layer. to add this variable, press F8, or right-click and click Insert Variable.

getBandIndex

public Object getBandIndex()

Returns the Bands parameter of this tool . This parameter is choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output. This is an optional parameter.

Returns:

the Bands

setBandIndex

public void setBandIndex(Object bandIndex)

Sets the Bands parameter of this tool . This parameter is choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output. This is an optional parameter.

Parameters:

bandIndex - choose which bands to export for the layer. If no bands are specified, then all the bands will be used in the output.

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