com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class SurfaceSpot

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.SurfaceSpot

All Implemented Interfaces:

GPTool

public class SurfaceSpot
extends AbstractGPTool

Calculates surface values for each point of a point feature class by interpolating from a raster, TIN, or terrain dataset surface. The Surface Spot tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Ensure the input surface and the input feature class have overlapping extents.
• Use the {z_factor} argument to convert the output field to the desired units.

Field Summary

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

vals

Constructor Summary

SurfaceSpot()
Creates the Surface Spot tool with defaults.

SurfaceSpot(Object inSurface, Object inFeatureClass)
Creates the Surface Spot tool with the required parameters.

Method Summary

Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
String	getMethod() Returns the Method parameter of this tool .
Object	getOutputFeatureClass() Returns the Output Feature Class parameter of this tool (Read only).
String	getOutSpotField() Returns the Spot Field parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution 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.
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setMethod(String method) Sets the Method parameter of this tool .
void	setOutSpotField(String outSpotField) Sets the Spot Field parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor 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

SurfaceSpot

public SurfaceSpot()

Creates the Surface Spot tool with defaults.

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

SurfaceSpot

public SurfaceSpot(Object inSurface,
                   Object inFeatureClass)

Creates the Surface Spot 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:

inSurface - the input raster, TIN, or Terrain dataset surface to be used for interpolation.

inFeatureClass - the input point feature class to which the interpolated values will be added.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the input raster, TIN, or Terrain dataset surface to be used for interpolation. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is the input raster, TIN, or Terrain dataset surface to be used for interpolation. This is a required parameter.

Parameters:

inSurface - the input raster, TIN, or Terrain dataset surface to be used for interpolation.

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input point feature class to which the interpolated values will be added. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the input point feature class to which the interpolated values will be added. This is a required parameter.

Parameters:

inFeatureClass - the input point feature class to which the interpolated values will be added.

getOutSpotField

public String getOutSpotField()

Returns the Spot Field parameter of this tool . This parameter is the name of the attribute field to be added to the input feature class. By default, the name is Spot. This is an optional parameter.

Returns:

the Spot Field

setOutSpotField

public void setOutSpotField(String outSpotField)

Sets the Spot Field parameter of this tool . This parameter is the name of the attribute field to be added to the input feature class. By default, the name is Spot. This is an optional parameter.

Parameters:

outSpotField - the name of the attribute field to be added to the input feature class. By default, the name is Spot.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor multiplied by the surface values to convert them to new values added to the input feature class. Used to convert z units to match x,y units. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is the factor multiplied by the surface values to convert them to new values added to the input feature class. Used to convert z units to match x,y units. This is an optional parameter.

Parameters:

zFactor - the factor multiplied by the surface values to convert them to new values added to the input feature class. Used to convert z units to match x,y units.

getMethod

public String getMethod()

Returns the Method parameter of this tool . This parameter is algorithm used to calculate surface values. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(String method)

Sets the Method parameter of this tool . This parameter is algorithm used to calculate surface values. This is an optional parameter.

Parameters:

method - algorithm used to calculate surface values.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution. This is an optional parameter.

Returns:

the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Feature Class

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