com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class HighestPosition

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

public class HighestPosition
extends AbstractGPTool

Determines the position of a raster with the maximum value in a set of rasters. The Highest Position tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
HighestPosition()
          Creates the Highest Position tool with defaults.
HighestPosition(Object inRastersOrConstants, Object outRaster)
          Creates the Highest Position tool with the required parameters.
 
Method Summary
 Object getInRastersOrConstants()
          Returns the Input rasters or constant values parameter of this tool .
 Object getOutRaster()
          Returns the Output raster 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 setInRastersOrConstants(Object inRastersOrConstants)
          Sets the Input rasters or constant values parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster 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

HighestPosition

public HighestPosition()
Creates the Highest Position tool with defaults.

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


HighestPosition

public HighestPosition(Object inRastersOrConstants,
                       Object outRaster)
Creates the Highest Position 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:
inRastersOrConstants - Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number.
outRaster - Raster Dataset, the raster to be created.
Method Detail

getInRastersOrConstants

public Object getInRastersOrConstants()
Returns the Input rasters or constant values parameter of this tool . This parameter is Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number. This is a required parameter.

Returns:
the Input rasters or constant values

setInRastersOrConstants

public void setInRastersOrConstants(Object inRastersOrConstants)
Sets the Input rasters or constant values parameter of this tool . This parameter is Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number. This is a required parameter.

Parameters:
inRastersOrConstants - Composite Geodataset, a number can be input as an argument, but it will be converted to a raster at the current window and its cell size will be set in the analysis environment, with each location containing the input number.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. 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, the raster to be created. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the raster to be created.

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