com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class CreateFishnet

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

public class CreateFishnet
extends AbstractGPTool

Creates a fishnet of rectangular cells. The Create Fishnet tool is contained in the Data Management Tools tool box.
Learn more about how Create Fishnet works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateFishnet()
          Creates the Create Fishnet tool with defaults.
CreateFishnet(Object outFeatureClass, Object originCoord, Object yAxisCoord, double cellWidth, double cellHeight, int numberRows, int numberColumns)
          Creates the Create Fishnet tool with the required parameters.
 
Method Summary
 double getCellHeight()
          Returns the Cell Size Height parameter of this tool .
 double getCellWidth()
          Returns the Cell Size Width parameter of this tool .
 Object getCornerCoord()
          Returns the Opposite corner of Fishnet parameter of this tool .
 String getLabels()
          Returns the Create Labels parameter of this tool .
 int getNumberColumns()
          Returns the Number of Columns parameter of this tool .
 int getNumberRows()
          Returns the Number of Rows parameter of this tool .
 Object getOriginCoord()
          Returns the Fishnet Origin Coordinate parameter of this tool .
 Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 Object getOutLabel()
          Returns the Output Labels parameter of this tool (Read only).
 Object getTemplate()
          Returns the Template Extent 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.
 Object getYAxisCoord()
          Returns the Y-Axis Coordinate parameter of this tool .
 void setCellHeight(double cellHeight)
          Sets the Cell Size Height parameter of this tool .
 void setCellWidth(double cellWidth)
          Sets the Cell Size Width parameter of this tool .
 void setCornerCoord(Object cornerCoord)
          Sets the Opposite corner of Fishnet parameter of this tool .
 void setLabels(String labels)
          Sets the Create Labels parameter of this tool .
 void setNumberColumns(int numberColumns)
          Sets the Number of Columns parameter of this tool .
 void setNumberRows(int numberRows)
          Sets the Number of Rows parameter of this tool .
 void setOriginCoord(Object originCoord)
          Sets the Fishnet Origin Coordinate parameter of this tool .
 void setOutFeatureClass(Object outFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setTemplate(Object template)
          Sets the Template Extent parameter of this tool .
 void setYAxisCoord(Object yAxisCoord)
          Sets the Y-Axis Coordinate 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

CreateFishnet

public CreateFishnet()
Creates the Create Fishnet tool with defaults.

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


CreateFishnet

public CreateFishnet(Object outFeatureClass,
                     Object originCoord,
                     Object yAxisCoord,
                     double cellWidth,
                     double cellHeight,
                     int numberRows,
                     int numberColumns)
Creates the Create Fishnet 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:
outFeatureClass - Feature Class, the output feature class containing the fishnet of rectangular cells.
originCoord - Point, the fishnet origin is the lower-left corner of the fishnet set by a X-Coordinate and Y-Coordinate.
yAxisCoord - Point, the y-axis coordinate is a point on the positive y-axis from the origin point and is used to orient the fishnet.
cellWidth - Double, the cell size width refers to the size of the cells in the x-coordinate position.
cellHeight - Double, the cell size height refers to the size of the cells in the y-coordinate direction.
numberRows - Long, the number of rows used with the cell size to determine the size of the fishnet.
numberColumns - Long, the number of columns used with the cell size to determine the size of the fishnet.
Method Detail

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class containing the fishnet of rectangular cells. 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 Feature Class, the output feature class containing the fishnet of rectangular cells. This is a required parameter.

Parameters:
outFeatureClass - Feature Class, the output feature class containing the fishnet of rectangular cells.

getOriginCoord

public Object getOriginCoord()
Returns the Fishnet Origin Coordinate parameter of this tool . This parameter is Point, the fishnet origin is the lower-left corner of the fishnet set by a X-Coordinate and Y-Coordinate. This is a required parameter.

Returns:
the Fishnet Origin Coordinate

setOriginCoord

public void setOriginCoord(Object originCoord)
Sets the Fishnet Origin Coordinate parameter of this tool . This parameter is Point, the fishnet origin is the lower-left corner of the fishnet set by a X-Coordinate and Y-Coordinate. This is a required parameter.

Parameters:
originCoord - Point, the fishnet origin is the lower-left corner of the fishnet set by a X-Coordinate and Y-Coordinate.

getYAxisCoord

public Object getYAxisCoord()
Returns the Y-Axis Coordinate parameter of this tool . This parameter is Point, the y-axis coordinate is a point on the positive y-axis from the origin point and is used to orient the fishnet. This is a required parameter.

Returns:
the Y-Axis Coordinate

setYAxisCoord

public void setYAxisCoord(Object yAxisCoord)
Sets the Y-Axis Coordinate parameter of this tool . This parameter is Point, the y-axis coordinate is a point on the positive y-axis from the origin point and is used to orient the fishnet. This is a required parameter.

Parameters:
yAxisCoord - Point, the y-axis coordinate is a point on the positive y-axis from the origin point and is used to orient the fishnet.

getCellWidth

public double getCellWidth()
Returns the Cell Size Width parameter of this tool . This parameter is Double, the cell size width refers to the size of the cells in the x-coordinate position. This is a required parameter.

Returns:
the Cell Size Width

setCellWidth

public void setCellWidth(double cellWidth)
Sets the Cell Size Width parameter of this tool . This parameter is Double, the cell size width refers to the size of the cells in the x-coordinate position. This is a required parameter.

Parameters:
cellWidth - Double, the cell size width refers to the size of the cells in the x-coordinate position.

getCellHeight

public double getCellHeight()
Returns the Cell Size Height parameter of this tool . This parameter is Double, the cell size height refers to the size of the cells in the y-coordinate direction. This is a required parameter.

Returns:
the Cell Size Height

setCellHeight

public void setCellHeight(double cellHeight)
Sets the Cell Size Height parameter of this tool . This parameter is Double, the cell size height refers to the size of the cells in the y-coordinate direction. This is a required parameter.

Parameters:
cellHeight - Double, the cell size height refers to the size of the cells in the y-coordinate direction.

getNumberRows

public int getNumberRows()
Returns the Number of Rows parameter of this tool . This parameter is Long, the number of rows used with the cell size to determine the size of the fishnet. This is a required parameter.

Returns:
the Number of Rows

setNumberRows

public void setNumberRows(int numberRows)
Sets the Number of Rows parameter of this tool . This parameter is Long, the number of rows used with the cell size to determine the size of the fishnet. This is a required parameter.

Parameters:
numberRows - Long, the number of rows used with the cell size to determine the size of the fishnet.

getNumberColumns

public int getNumberColumns()
Returns the Number of Columns parameter of this tool . This parameter is Long, the number of columns used with the cell size to determine the size of the fishnet. This is a required parameter.

Returns:
the Number of Columns

setNumberColumns

public void setNumberColumns(int numberColumns)
Sets the Number of Columns parameter of this tool . This parameter is Long, the number of columns used with the cell size to determine the size of the fishnet. This is a required parameter.

Parameters:
numberColumns - Long, the number of columns used with the cell size to determine the size of the fishnet.

getCornerCoord

public Object getCornerCoord()
Returns the Opposite corner of Fishnet parameter of this tool . This parameter is Point, the opposite corner of the fishnet is the upper-right corner of the fishnet set by a X-Coordinate and Y-Coordinate. This is an optional parameter.

Returns:
the Opposite corner of Fishnet

setCornerCoord

public void setCornerCoord(Object cornerCoord)
Sets the Opposite corner of Fishnet parameter of this tool . This parameter is Point, the opposite corner of the fishnet is the upper-right corner of the fishnet set by a X-Coordinate and Y-Coordinate. This is an optional parameter.

Parameters:
cornerCoord - Point, the opposite corner of the fishnet is the upper-right corner of the fishnet set by a X-Coordinate and Y-Coordinate.

getLabels

public String getLabels()
Returns the Create Labels parameter of this tool . This parameter is String, specify whether or not a point feature class will be created containing label points at the center of each fishnet cell. Labels are generated by default. This is an optional parameter.

Returns:
the Create Labels

setLabels

public void setLabels(String labels)
Sets the Create Labels parameter of this tool . This parameter is String, specify whether or not a point feature class will be created containing label points at the center of each fishnet cell. Labels are generated by default. This is an optional parameter.

Parameters:
labels - String, specify whether or not a point feature class will be created containing label points at the center of each fishnet cell. Labels are generated by default.

getTemplate

public Object getTemplate()
Returns the Template Extent parameter of this tool . This parameter is , specify the extent of the fishnet. The extent can be entered by specifying the coordinates or using a template dataset. This is an optional parameter.

Returns:
the Template Extent

setTemplate

public void setTemplate(Object template)
Sets the Template Extent parameter of this tool . This parameter is , specify the extent of the fishnet. The extent can be entered by specifying the coordinates or using a template dataset. This is an optional parameter.

Parameters:
template - , specify the extent of the fishnet. The extent can be entered by specifying the coordinates or using a template dataset.

getOutLabel

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

Returns:
the Output Labels

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