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

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

public class ExtractValuesToPoints
extends AbstractGPTool

Extracts the cell values of a raster based on a set of points. The Extract Values to Points tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ExtractValuesToPoints()
          Creates the Extract Values to Points tool with defaults.
ExtractValuesToPoints(Object inPointFeatures, Object inRaster, Object outPointFeatures)
          Creates the Extract Values to Points tool with the required parameters.
 
Method Summary
 String getAddAttributes()
          Returns the Append all the input raster attributes to the output point features parameter of this tool .
 Object getInPointFeatures()
          Returns the Input point features parameter of this tool .
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 String getInterpolateValues()
          Returns the Interpolate values at the point locations parameter of this tool .
 Object getOutPointFeatures()
          Returns the Output point features 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 setAddAttributes(String addAttributes)
          Sets the Append all the input raster attributes to the output point features parameter of this tool .
 void setInPointFeatures(Object inPointFeatures)
          Sets the Input point features parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setInterpolateValues(String interpolateValues)
          Sets the Interpolate values at the point locations parameter of this tool .
 void setOutPointFeatures(Object outPointFeatures)
          Sets the Output point features 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

ExtractValuesToPoints

public ExtractValuesToPoints()
Creates the Extract Values to Points tool with defaults.

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


ExtractValuesToPoints

public ExtractValuesToPoints(Object inPointFeatures,
                             Object inRaster,
                             Object outPointFeatures)
Creates the Extract Values to Points 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:
inPointFeatures - Composite Geodataset, the input point features to which you want to add raster values.
inRaster - Composite Geodataset, the name of a raster dataset whose values you want to add to the input point features.
outPointFeatures - Feature Class, the output point feature dataset containing the extracted raster values.
Method Detail

getInPointFeatures

public Object getInPointFeatures()
Returns the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features to which you want to add raster values. This is a required parameter.

Returns:
the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)
Sets the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features to which you want to add raster values. This is a required parameter.

Parameters:
inPointFeatures - Composite Geodataset, the input point features to which you want to add raster values.

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, the name of a raster dataset whose values you want to add to the input point features. 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 Composite Geodataset, the name of a raster dataset whose values you want to add to the input point features. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, the name of a raster dataset whose values you want to add to the input point features.

getOutPointFeatures

public Object getOutPointFeatures()
Returns the Output point features parameter of this tool . This parameter is Feature Class, the output point feature dataset containing the extracted raster values. This is a required parameter.

Returns:
the Output point features

setOutPointFeatures

public void setOutPointFeatures(Object outPointFeatures)
Sets the Output point features parameter of this tool . This parameter is Feature Class, the output point feature dataset containing the extracted raster values. This is a required parameter.

Parameters:
outPointFeatures - Feature Class, the output point feature dataset containing the extracted raster values.

getInterpolateValues

public String getInterpolateValues()
Returns the Interpolate values at the point locations parameter of this tool . This parameter is String, specifies whether or not interpolation will be used. This is an optional parameter.

Returns:
the Interpolate values at the point locations

setInterpolateValues

public void setInterpolateValues(String interpolateValues)
Sets the Interpolate values at the point locations parameter of this tool . This parameter is String, specifies whether or not interpolation will be used. This is an optional parameter.

Parameters:
interpolateValues - String, specifies whether or not interpolation will be used.

getAddAttributes

public String getAddAttributes()
Returns the Append all the input raster attributes to the output point features parameter of this tool . This parameter is String, determines if the raster attributes are written to the output point feature dataset. This is an optional parameter.

Returns:
the Append all the input raster attributes to the output point features

setAddAttributes

public void setAddAttributes(String addAttributes)
Sets the Append all the input raster attributes to the output point features parameter of this tool . This parameter is String, determines if the raster attributes are written to the output point feature dataset. This is an optional parameter.

Parameters:
addAttributes - String, determines if the raster attributes are written to the output point feature dataset.

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