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

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

public class LessThanEqual
extends AbstractGPTool

Performs a Relational less-than-or-equal-to operation on two inputs on a cell-by-cell basis. The Less Than Equal tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
LessThanEqual()
          Creates the Less Than Equal tool with defaults.
LessThanEqual(java.lang.Object inRasterOrConstant1, java.lang.Object inRasterOrConstant2, java.lang.Object outRaster)
          Creates the Less Than Equal tool with the required parameters.
 
Method Summary
 java.lang.Object getInRasterOrConstant1()
          Returns the Input raster or constant value 1 parameter of this tool .
 java.lang.Object getInRasterOrConstant2()
          Returns the Input raster or constant value 2 parameter of this tool .
 java.lang.Object getOutRaster()
          Returns the Output raster parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setInRasterOrConstant1(java.lang.Object inRasterOrConstant1)
          Sets the Input raster or constant value 1 parameter of this tool .
 void setInRasterOrConstant2(java.lang.Object inRasterOrConstant2)
          Sets the Input raster or constant value 2 parameter of this tool .
 void setOutRaster(java.lang.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

LessThanEqual

public LessThanEqual()
Creates the Less Than Equal tool with defaults.

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


LessThanEqual

public LessThanEqual(java.lang.Object inRasterOrConstant1,
                     java.lang.Object inRasterOrConstant2,
                     java.lang.Object outRaster)
Creates the Less Than Equal 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:
inRasterOrConstant1 - the input being tested to determine if it is less than or equal to the second input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.
inRasterOrConstant2 - the input against which the first input is tested to be less than or equal to. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.
outRaster - the output raster. the output cell values will be either integer 0 or 1; or NoData if any input cell value is NoData.
Method Detail

getInRasterOrConstant1

public java.lang.Object getInRasterOrConstant1()
Returns the Input raster or constant value 1 parameter of this tool . This parameter is the input being tested to determine if it is less than or equal to the second input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:
the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(java.lang.Object inRasterOrConstant1)
Sets the Input raster or constant value 1 parameter of this tool . This parameter is the input being tested to determine if it is less than or equal to the second input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:
inRasterOrConstant1 - the input being tested to determine if it is less than or equal to the second input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

getInRasterOrConstant2

public java.lang.Object getInRasterOrConstant2()
Returns the Input raster or constant value 2 parameter of this tool . This parameter is the input against which the first input is tested to be less than or equal to. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:
the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(java.lang.Object inRasterOrConstant2)
Sets the Input raster or constant value 2 parameter of this tool . This parameter is the input against which the first input is tested to be less than or equal to. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:
inRasterOrConstant2 - the input against which the first input is tested to be less than or equal to. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

getOutRaster

public java.lang.Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output raster. the output cell values will be either integer 0 or 1; or NoData if any input cell value is NoData. This is a required parameter.

Returns:
the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)
Sets the Output raster parameter of this tool . This parameter is the output raster. the output cell values will be either integer 0 or 1; or NoData if any input cell value is NoData. This is a required parameter.

Parameters:
outRaster - the output raster. the output cell values will be either integer 0 or 1; or NoData if any input cell value is NoData.

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias