com.esri.arcgis.geoprocessing.tools.conversiontools
Class PolylineToRaster

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.PolylineToRaster

All Implemented Interfaces:

GPTool

public class PolylineToRaster
extends AbstractGPTool

Converts polyline features to a raster dataset. The Polyline to Raster tool is contained in the Conversion Tools tool box.

Usage tips:

• Any feature class (geodatabase, shapefile or coverage) containing polyline features can be converted to a raster dataset.
• The input field type determines the type of output raster. If the field is integer, the output raster will be integer; if it is floating-point, the output will be floating-point.If the input field contains string values, the output raster will contain an integer value field and a string field.
• This tool is a complement to the tool, which convert a raster to a polyline feature class.
• This tool provides greater control over the assignment of cell values when more than one feature is present in an output cell than the tool.

Field Summary

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

vals

Constructor Summary

PolylineToRaster()
Creates the Polyline to Raster tool with defaults.

PolylineToRaster(Object inFeatures, Object valueField, Object outRasterDataset)
Creates the Polyline to Raster tool with the required parameters.

Method Summary

String	getCellAssignment() Returns the Cell assignment type parameter of this tool .
Object	getCellsize() Returns the Cellsize parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutRasterDataset() Returns the Output Raster Dataset parameter of this tool .
Object	getPriorityField() Returns the Priority field 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	getValueField() Returns the Value field parameter of this tool .
void	setCellAssignment(String cellAssignment) Sets the Cell assignment type parameter of this tool .
void	setCellsize(Object cellsize) Sets the Cellsize parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutRasterDataset(Object outRasterDataset) Sets the Output Raster Dataset parameter of this tool .
void	setPriorityField(Object priorityField) Sets the Priority field parameter of this tool .
void	setValueField(Object valueField) Sets the Value field 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

PolylineToRaster

public PolylineToRaster()

Creates the Polyline to Raster tool with defaults.

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

PolylineToRaster

public PolylineToRaster(Object inFeatures,
                        Object valueField,
                        Object outRasterDataset)

Creates the Polyline to Raster 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:

inFeatures - the polyline input feature dataset to be converted to a raster.

valueField - the field used to assign values to the output raster. it can be any field of the input feature dataset's attribute table.

outRasterDataset - the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the polyline input feature dataset to be converted to a raster. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the polyline input feature dataset to be converted to a raster. This is a required parameter.

Parameters:

inFeatures - the polyline input feature dataset to be converted to a raster.

getValueField

public Object getValueField()

Returns the Value field parameter of this tool . This parameter is the field used to assign values to the output raster. it can be any field of the input feature dataset's attribute table. This is a required parameter.

Returns:

the Value field

setValueField

public void setValueField(Object valueField)

Sets the Value field parameter of this tool . This parameter is the field used to assign values to the output raster. it can be any field of the input feature dataset's attribute table. This is a required parameter.

Parameters:

valueField - the field used to assign values to the output raster. it can be any field of the input feature dataset's attribute table.

getOutRasterDataset

public Object getOutRasterDataset()

Returns the Output Raster Dataset parameter of this tool . This parameter is the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format. This is a required parameter.

Returns:

the Output Raster Dataset

setOutRasterDataset

public void setOutRasterDataset(Object outRasterDataset)

Sets the Output Raster Dataset parameter of this tool . This parameter is the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format. This is a required parameter.

Parameters:

outRasterDataset - the output raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID raster format.

getCellAssignment

public String getCellAssignment()

Returns the Cell assignment type parameter of this tool . This parameter is the method to determine how the cell will be assigned a value when more than one feature falls within a cell. This is an optional parameter.

Returns:

the Cell assignment type

setCellAssignment

public void setCellAssignment(String cellAssignment)

Sets the Cell assignment type parameter of this tool . This parameter is the method to determine how the cell will be assigned a value when more than one feature falls within a cell. This is an optional parameter.

Parameters:

cellAssignment - the method to determine how the cell will be assigned a value when more than one feature falls within a cell.

getPriorityField

public Object getPriorityField()

Returns the Priority field parameter of this tool . This parameter is this field is used when a feature should take preference over another feature with the same attribute. This is an optional parameter.

Returns:

the Priority field

setPriorityField

public void setPriorityField(Object priorityField)

Sets the Priority field parameter of this tool . This parameter is this field is used when a feature should take preference over another feature with the same attribute. This is an optional parameter.

Parameters:

priorityField - this field is used when a feature should take preference over another feature with the same attribute.

getCellsize

public Object getCellsize()

Returns the Cellsize parameter of this tool . This parameter is the cell size for the output raster dataset. the default cell size is the shortest of the width or height of the extent of the input feature dataset, in the output spatial reference, divided by 250. This is an optional parameter.

Returns:

the Cellsize

setCellsize

public void setCellsize(Object cellsize)

Sets the Cellsize parameter of this tool . This parameter is the cell size for the output raster dataset. the default cell size is the shortest of the width or height of the extent of the input feature dataset, in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellsize - the cell size for the output raster dataset. the default cell size is the shortest of the width or height of the extent of the input feature dataset, in the output spatial reference, divided by 250.

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