com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class GALayerToGrid

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

public class GALayerToGrid
extends AbstractGPTool

Exports a Geostatistical layer to an ArcInfo GRID. The GA Layer To Grid tool is contained in the Geostatistical Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
GALayerToGrid()
          Creates the GA Layer To Grid tool with defaults.
GALayerToGrid(Object inGeostatLayer, Object outSurfaceGrid)
          Creates the GA Layer To Grid tool with the required parameters.
 
Method Summary
 Object getCellSize()
          Returns the Output cell size parameter of this tool .
 Object getInGeostatLayer()
          Returns the Input geostatistical layer parameter of this tool .
 Object getOutSurfaceGrid()
          Returns the Output surface grid parameter of this tool .
 int getPointsPerBlockHorz()
          Returns the # of points in the cell (horizontal) parameter of this tool .
 int getPointsPerBlockVert()
          Returns the # of points in the cell (vertical) 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 setCellSize(Object cellSize)
          Sets the Output cell size parameter of this tool .
 void setInGeostatLayer(Object inGeostatLayer)
          Sets the Input geostatistical layer parameter of this tool .
 void setOutSurfaceGrid(Object outSurfaceGrid)
          Sets the Output surface grid parameter of this tool .
 void setPointsPerBlockHorz(int pointsPerBlockHorz)
          Sets the # of points in the cell (horizontal) parameter of this tool .
 void setPointsPerBlockVert(int pointsPerBlockVert)
          Sets the # of points in the cell (vertical) 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

GALayerToGrid

public GALayerToGrid()
Creates the GA Layer To Grid tool with defaults.

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


GALayerToGrid

public GALayerToGrid(Object inGeostatLayer,
                     Object outSurfaceGrid)
Creates the GA Layer To Grid 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:
inGeostatLayer - Geostatistical Layer, input Geostatistical layer.
outSurfaceGrid - Raster Dataset, the ArcInfo GRID to be created.
Method Detail

getInGeostatLayer

public Object getInGeostatLayer()
Returns the Input geostatistical layer parameter of this tool . This parameter is Geostatistical Layer, input Geostatistical layer. This is a required parameter.

Returns:
the Input geostatistical layer

setInGeostatLayer

public void setInGeostatLayer(Object inGeostatLayer)
Sets the Input geostatistical layer parameter of this tool . This parameter is Geostatistical Layer, input Geostatistical layer. This is a required parameter.

Parameters:
inGeostatLayer - Geostatistical Layer, input Geostatistical layer.

getOutSurfaceGrid

public Object getOutSurfaceGrid()
Returns the Output surface grid parameter of this tool . This parameter is Raster Dataset, the ArcInfo GRID to be created. This is a required parameter.

Returns:
the Output surface grid

setOutSurfaceGrid

public void setOutSurfaceGrid(Object outSurfaceGrid)
Sets the Output surface grid parameter of this tool . This parameter is Raster Dataset, the ArcInfo GRID to be created. This is a required parameter.

Parameters:
outSurfaceGrid - Raster Dataset, the ArcInfo GRID to be created.

getCellSize

public Object getCellSize()
Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, the cell size at which the output GRID will be created. This is an optional parameter.

Returns:
the Output cell size

setCellSize

public void setCellSize(Object cellSize)
Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, the cell size at which the output GRID will be created. This is an optional parameter.

Parameters:
cellSize - Analysis cell size, the cell size at which the output GRID will be created.

getPointsPerBlockHorz

public int getPointsPerBlockHorz()
Returns the # of points in the cell (horizontal) parameter of this tool . This parameter is Long, the number of predictions for each cell in the horizontal direction for block interpolation. This is an optional parameter.

Returns:
the # of points in the cell (horizontal)

setPointsPerBlockHorz

public void setPointsPerBlockHorz(int pointsPerBlockHorz)
Sets the # of points in the cell (horizontal) parameter of this tool . This parameter is Long, the number of predictions for each cell in the horizontal direction for block interpolation. This is an optional parameter.

Parameters:
pointsPerBlockHorz - Long, the number of predictions for each cell in the horizontal direction for block interpolation.

getPointsPerBlockVert

public int getPointsPerBlockVert()
Returns the # of points in the cell (vertical) parameter of this tool . This parameter is Long, the number of predictions for each cell in the vertical direction for block interpolation. This is an optional parameter.

Returns:
the # of points in the cell (vertical)

setPointsPerBlockVert

public void setPointsPerBlockVert(int pointsPerBlockVert)
Sets the # of points in the cell (vertical) parameter of this tool . This parameter is Long, the number of predictions for each cell in the vertical direction for block interpolation. This is an optional parameter.

Parameters:
pointsPerBlockVert - Long, the number of predictions for each cell in the vertical direction for block interpolation.

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