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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.RoundUp

All Implemented Interfaces:

GPTool

public class RoundUp
extends AbstractGPTool

Returns the next higher whole number for each cell in a raster. The Round Up tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• Input values can be positive or negative.
• The output raster is always floating point.
• In Round Up, if a number has any values to the right of the decimal point, the output will be assigned the next highest whole value: Input Output 5.3 6.0 4.9 5.0 3.0 3.0 6.5 7.0 -0.2 0.0 -2.8 -2.0
• A number can be used as an input; however, the cell size and extent must first be set in the environment.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

RoundUp()
Creates the Round Up tool with defaults.

RoundUp(Object inRasterOrConstant, Object outRaster)
Creates the Round Up tool with the required parameters.

Method Summary

Object	getInRasterOrConstant() Returns the Input raster or constant value 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	setInRasterOrConstant(Object inRasterOrConstant) Sets the Input raster or constant value 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

RoundUp

public RoundUp()

Creates the Round Up tool with defaults.

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

RoundUp

public RoundUp(Object inRasterOrConstant,
               Object outRaster)

Creates the Round Up 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:

inRasterOrConstant - Composite Geodataset, the input raster or constant value to be rounded up.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is Composite Geodataset, the input raster or constant value to be rounded up. This is a required parameter.

Returns:

the Input raster or constant value

setInRasterOrConstant

public void setInRasterOrConstant(Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is Composite Geodataset, the input raster or constant value to be rounded up. This is a required parameter.

Parameters:

inRasterOrConstant - Composite Geodataset, the input raster or constant value to be rounded up.

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