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

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

All Implemented Interfaces:

GPTool

public class GetRasterProperties
extends AbstractGPTool

Returns the properties of a raster dataset. The Get Raster Properties tool is contained in the Data Management Tools tool box.

Usage tips:

• The property returned will be displayed in the geoprocessing window.

Field Summary

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

vals

Constructor Summary

GetRasterProperties()
Creates the Get Raster Properties tool with defaults.

GetRasterProperties(Object inRaster)
Creates the Get Raster Properties tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
double	getProperty() Returns the Property parameter of this tool (Read only).
String	getPropertyType() Returns the Property type 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	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setPropertyType(String propertyType) Sets the Property type 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

GetRasterProperties

public GetRasterProperties()

Creates the Get Raster Properties tool with defaults.

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

GetRasterProperties

public GetRasterProperties(Object inRaster)

Creates the Get Raster Properties 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 input raster dataset.

Method Detail

getInRaster

public Object getInRaster()

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

Parameters:

inRaster - the input raster dataset.

getPropertyType

public String getPropertyType()

Returns the Property type parameter of this tool . This parameter is the property to be obtained from the raster dataset. This is an optional parameter.

Returns:

the Property type

setPropertyType

public void setPropertyType(String propertyType)

Sets the Property type parameter of this tool . This parameter is the property to be obtained from the raster dataset. This is an optional parameter.

Parameters:

propertyType - the property to be obtained from the raster dataset.

getProperty

public double getProperty()

Returns the Property parameter of this tool (Read only). This is an derived parameter.

Returns:

the Property

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