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

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

public class CreateTerrain
extends AbstractGPTool

Creates a new terrain dataset inside the specified feature dataset. Use Add Terrain Pyramid Levels, Add Feature Classes To Terrain, followed by Build Terrain to complete the terrain definition and construct a usable terrain. The Create Terrain tool is contained in the 3D Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateTerrain()
          Creates the Create Terrain tool with defaults.
CreateTerrain(Object inFeatureDataset, String outTerrainName, double averagePointSpacing)
          Creates the Create Terrain tool with the required parameters.
 
Method Summary
 double getAveragePointSpacing()
          Returns the Average Point Spacing parameter of this tool .
 String getConfigKeyword()
          Returns the Config Keyword parameter of this tool .
 Object getDerivedOutTerrain()
          Returns the Output Terrain parameter of this tool (Read only).
 Object getInFeatureDataset()
          Returns the Input Feature Dataset parameter of this tool .
 int getMaxOverviewSize()
          Returns the Maximum Overview Size parameter of this tool .
 String getOutTerrainName()
          Returns the Output Terrain parameter of this tool .
 String getPyramidType()
          Returns the Pyramid Type parameter of this tool .
 String getSecondaryThinningMethod()
          Returns the Secondary Thinning Method parameter of this tool .
 double getSecondaryThinningThreshold()
          Returns the Secondary Thinning Threshold 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.
 String getWindowsizeMethod()
          Returns the Window Size Method parameter of this tool .
 void setAveragePointSpacing(double averagePointSpacing)
          Sets the Average Point Spacing parameter of this tool .
 void setConfigKeyword(String configKeyword)
          Sets the Config Keyword parameter of this tool .
 void setInFeatureDataset(Object inFeatureDataset)
          Sets the Input Feature Dataset parameter of this tool .
 void setMaxOverviewSize(int maxOverviewSize)
          Sets the Maximum Overview Size parameter of this tool .
 void setOutTerrainName(String outTerrainName)
          Sets the Output Terrain parameter of this tool .
 void setPyramidType(String pyramidType)
          Sets the Pyramid Type parameter of this tool .
 void setSecondaryThinningMethod(String secondaryThinningMethod)
          Sets the Secondary Thinning Method parameter of this tool .
 void setSecondaryThinningThreshold(double secondaryThinningThreshold)
          Sets the Secondary Thinning Threshold parameter of this tool .
 void setWindowsizeMethod(String windowsizeMethod)
          Sets the Window Size Method 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

CreateTerrain

public CreateTerrain()
Creates the Create Terrain tool with defaults.

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


CreateTerrain

public CreateTerrain(Object inFeatureDataset,
                     String outTerrainName,
                     double averagePointSpacing)
Creates the Create Terrain 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:
inFeatureDataset - Feature Dataset, the feature dataset where the terrain will be created.
outTerrainName - String, the output terrain.
averagePointSpacing - Double, the average distance between input points and vertices.
Method Detail

getInFeatureDataset

public Object getInFeatureDataset()
Returns the Input Feature Dataset parameter of this tool . This parameter is Feature Dataset, the feature dataset where the terrain will be created. This is a required parameter.

Returns:
the Input Feature Dataset

setInFeatureDataset

public void setInFeatureDataset(Object inFeatureDataset)
Sets the Input Feature Dataset parameter of this tool . This parameter is Feature Dataset, the feature dataset where the terrain will be created. This is a required parameter.

Parameters:
inFeatureDataset - Feature Dataset, the feature dataset where the terrain will be created.

getOutTerrainName

public String getOutTerrainName()
Returns the Output Terrain parameter of this tool . This parameter is String, the output terrain. This is a required parameter.

Returns:
the Output Terrain

setOutTerrainName

public void setOutTerrainName(String outTerrainName)
Sets the Output Terrain parameter of this tool . This parameter is String, the output terrain. This is a required parameter.

Parameters:
outTerrainName - String, the output terrain.

getAveragePointSpacing

public double getAveragePointSpacing()
Returns the Average Point Spacing parameter of this tool . This parameter is Double, the average distance between input points and vertices. This is a required parameter.

Returns:
the Average Point Spacing

setAveragePointSpacing

public void setAveragePointSpacing(double averagePointSpacing)
Sets the Average Point Spacing parameter of this tool . This parameter is Double, the average distance between input points and vertices. This is a required parameter.

Parameters:
averagePointSpacing - Double, the average distance between input points and vertices.

getMaxOverviewSize

public int getMaxOverviewSize()
Returns the Maximum Overview Size parameter of this tool . This parameter is Long, the terrain overview is the coarsest representation of the terrain. It's like a vector based thumbnail. The maximum size is the upper limit to the number of measurement points sampled to create the overview. This is an optional parameter.

Returns:
the Maximum Overview Size

setMaxOverviewSize

public void setMaxOverviewSize(int maxOverviewSize)
Sets the Maximum Overview Size parameter of this tool . This parameter is Long, the terrain overview is the coarsest representation of the terrain. It's like a vector based thumbnail. The maximum size is the upper limit to the number of measurement points sampled to create the overview. This is an optional parameter.

Parameters:
maxOverviewSize - Long, the terrain overview is the coarsest representation of the terrain. It's like a vector based thumbnail. The maximum size is the upper limit to the number of measurement points sampled to create the overview.

getConfigKeyword

public String getConfigKeyword()
Returns the Config Keyword parameter of this tool . This parameter is String, configuration keyword for ArcSDE. This is an optional parameter.

Returns:
the Config Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Config Keyword parameter of this tool . This parameter is String, configuration keyword for ArcSDE. This is an optional parameter.

Parameters:
configKeyword - String, configuration keyword for ArcSDE.

getPyramidType

public String getPyramidType()
Returns the Pyramid Type parameter of this tool . This parameter is String, the type of filter used by the terrain to construct the pyramid. This is an optional parameter.

Returns:
the Pyramid Type

setPyramidType

public void setPyramidType(String pyramidType)
Sets the Pyramid Type parameter of this tool . This parameter is String, the type of filter used by the terrain to construct the pyramid. This is an optional parameter.

Parameters:
pyramidType - String, the type of filter used by the terrain to construct the pyramid.

getWindowsizeMethod

public String getWindowsizeMethod()
Returns the Window Size Method parameter of this tool . This parameter is String, the criterion used for selecting points when the pyramid type is Window Size. This is an optional parameter.

Returns:
the Window Size Method

setWindowsizeMethod

public void setWindowsizeMethod(String windowsizeMethod)
Sets the Window Size Method parameter of this tool . This parameter is String, the criterion used for selecting points when the pyramid type is Window Size. This is an optional parameter.

Parameters:
windowsizeMethod - String, the criterion used for selecting points when the pyramid type is Window Size.

getSecondaryThinningMethod

public String getSecondaryThinningMethod()
Returns the Secondary Thinning Method parameter of this tool . This parameter is String, the type of additional thinning, if any, to use with the Window Size filter. This is an optional parameter.

Returns:
the Secondary Thinning Method

setSecondaryThinningMethod

public void setSecondaryThinningMethod(String secondaryThinningMethod)
Sets the Secondary Thinning Method parameter of this tool . This parameter is String, the type of additional thinning, if any, to use with the Window Size filter. This is an optional parameter.

Parameters:
secondaryThinningMethod - String, the type of additional thinning, if any, to use with the Window Size filter.

getSecondaryThinningThreshold

public double getSecondaryThinningThreshold()
Returns the Secondary Thinning Threshold parameter of this tool . This parameter is Double, the vertical threshold used to activate secondary thinning with the Window Size filter. The value should be set equal to or larger than the vertical accuracy of the data. This is an optional parameter.

Returns:
the Secondary Thinning Threshold

setSecondaryThinningThreshold

public void setSecondaryThinningThreshold(double secondaryThinningThreshold)
Sets the Secondary Thinning Threshold parameter of this tool . This parameter is Double, the vertical threshold used to activate secondary thinning with the Window Size filter. The value should be set equal to or larger than the vertical accuracy of the data. This is an optional parameter.

Parameters:
secondaryThinningThreshold - Double, the vertical threshold used to activate secondary thinning with the Window Size filter. The value should be set equal to or larger than the vertical accuracy of the data.

getDerivedOutTerrain

public Object getDerivedOutTerrain()
Returns the Output Terrain parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Terrain

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