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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• If 0 is specified for the Cell Size Width and the Cell Size Height, then specify the number of Rows and Columns, and the opposite corner of the fishnet (X, Y).
• The extent of the fishnest can be entered by specifying the coordinates or using a template dataset. When entering a template, the fishnet Orgin Coorindate and Y-Axis Coordinate are populated. You will still be required to enter the number of rows and columns.
• If 0 is specified for the Rows, Columns, then specify the opposite corner of the fishnet (X, Y).
• If 0 is entered for the Cell Size Width or Cell Size Height, then it will be automatically computed based on the number of Rows and Columns, and the opposite corner of the fishnet.
• If you specify the Cell Size Width and Cell Size Height and enter 0 for Rows and Columns, you will be required to enter the opposite corner of the fishnet. The specified Cell Size Width and Cell Size Height will be used to automatically calculate how many Rows and Columns can fit within the area defined by the origin the opposite corner of the fishnet without exceeding the corner coordinates.
• The Cell Size Width and the Cell Size Height are expressed in the same units as defined by the output featuure class. For example, a cell size of 0.5 is half of a degree in geographic, but 0.5 meters in UTM.
• Labels are generated by default. A new feature class is created with label points created at the center of each fishnet cell. This feature class is created in the same locaton as the output feature class. The name of this feature class is the same name as the output feature class with a suffix of _Labels.
• To generate polygon features from the line features you must use the Feature To Polygon; tool.
• Learn more about spatial reference and geoprocessing;
• The following environment settings affect this tool: Extent; M Domain; Configuration Keyword; Coordinate System; Output has M Values; Output Spatial Grid; Output has Z Values; Default Z Value; Output XY Domain; , and Output Z Domain;

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