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.

Usage tips:

• Input values can be positive or negative.
• The output raster from this tool is always floating point type, regardless of the input value type.
• If a number has any values to the right of the decimal point, the output will be assigned the next highest whole value. For example:

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 - the input values to be rounded up. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

outRaster - the output raster. the cell values are the input values converted to integers by rounding up to the next higher whole number.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is the input values to be rounded up. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. 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 the input values to be rounded up. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant - the input values to be rounded up. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the input values converted to integers by rounding up to the next higher whole number. 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 the output raster. the cell values are the input values converted to integers by rounding up to the next higher whole number. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the input values converted to integers by rounding up to the next higher whole number.

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