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

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

All Implemented Interfaces:

GPTool

public class TerrainToPoints
extends AbstractGPTool

This tool converts a terrain dataset into a new point or multipoint feature class. The Terrain to Points tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• If an embedded feature class is not specified, the output points will come from all of the feature classes used to define the surface for the given extent and pyramid level resolution.

Field Summary

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

vals

Constructor Summary

TerrainToPoints()
Creates the Terrain to Points tool with defaults.

TerrainToPoints(Object inTerrain, Object outFeatureClass)
Creates the Terrain to Points tool with the required parameters.

Method Summary

Object	getInTerrain() Returns the Input Terrain parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getOutGeometryType() Returns the Output Feature Class Type parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
String	getSourceEmbeddedFeatureClass() Returns the Input Embedded Feature Class 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	setInTerrain(Object inTerrain) Sets the Input Terrain parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutGeometryType(String outGeometryType) Sets the Output Feature Class Type parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setSourceEmbeddedFeatureClass(String sourceEmbeddedFeatureClass) Sets the Input Embedded Feature Class 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

TerrainToPoints

public TerrainToPoints()

Creates the Terrain to Points tool with defaults.

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

TerrainToPoints

public TerrainToPoints(Object inTerrain,
                       Object outFeatureClass)

Creates the Terrain 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:

inTerrain - the input terrain dataset.

outFeatureClass - the output point or multipoint feature class name.

Method Detail

getInTerrain

public Object getInTerrain()

Returns the Input Terrain parameter of this tool . This parameter is the input terrain dataset. This is a required parameter.

Returns:

the Input Terrain

setInTerrain

public void setInTerrain(Object inTerrain)

Sets the Input Terrain parameter of this tool . This parameter is the input terrain dataset. This is a required parameter.

Parameters:

inTerrain - the input terrain dataset.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output point or multipoint feature class name. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output point or multipoint feature class name. This is a required parameter.

Parameters:

outFeatureClass - the output point or multipoint feature class name.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the pyramid level to use for conversion. 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 pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Parameters:

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

getSourceEmbeddedFeatureClass

public String getSourceEmbeddedFeatureClass()

Returns the Input Embedded Feature Class parameter of this tool . This parameter is the terrain's embedded point feature class to use for output. if the Input Embedded Feature Class is not specified then the points are taken from all data sources of the terrain. If the Input Embedded Feature Class is specified the points are only taken from the embedded source. All attributes will be output. This is an optional parameter.

Returns:

the Input Embedded Feature Class

setSourceEmbeddedFeatureClass

public void setSourceEmbeddedFeatureClass(String sourceEmbeddedFeatureClass)

Sets the Input Embedded Feature Class parameter of this tool . This parameter is the terrain's embedded point feature class to use for output. if the Input Embedded Feature Class is not specified then the points are taken from all data sources of the terrain. If the Input Embedded Feature Class is specified the points are only taken from the embedded source. All attributes will be output. This is an optional parameter.

Parameters:

sourceEmbeddedFeatureClass - the terrain's embedded point feature class to use for output. if the Input Embedded Feature Class is not specified then the points are taken from all data sources of the terrain. If the Input Embedded Feature Class is specified the points are only taken from the embedded source. All attributes will be output.

getOutGeometryType

public String getOutGeometryType()

Returns the Output Feature Class Type parameter of this tool . This parameter is the type of the output features (multipoints or points). This is an optional parameter.

Returns:

the Output Feature Class Type

setOutGeometryType

public void setOutGeometryType(String outGeometryType)

Sets the Output Feature Class Type parameter of this tool . This parameter is the type of the output features (multipoints or points). This is an optional parameter.

Parameters:

outGeometryType - the type of the output features (multipoints or points).

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