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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.BearingDistanceToLine

All Implemented Interfaces:

GPTool

public class BearingDistanceToLine
extends AbstractGPTool

This tool converts a table to two-point lines based on an x-coordinate field, y-coordinate field, bearing field, and distance field. The Bearing Distance To Line tool is contained in the Data Management Tools tool box.

Usage tips:

• Each row in the input table creates one two-point line in the output feature class.

Field Summary

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

vals

Constructor Summary

BearingDistanceToLine()
Creates the Bearing Distance To Line tool with defaults.

BearingDistanceToLine(Object inTable, Object outFeatureclass, Object xField, Object yField, Object distanceField, String distanceUnits, Object bearingField, String bearingUnits, String lineType)
Creates the Bearing Distance To Line tool with the required parameters.

Method Summary

Object	getBearingField() Returns the Bearing Field parameter of this tool .
String	getBearingUnits() Returns the Bearing Units parameter of this tool .
Object	getDistanceField() Returns the Distance Field parameter of this tool .
String	getDistanceUnits() Returns the Distance Units parameter of this tool .
Object	getIdField() Returns the ID parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
String	getLineType() Returns the Line Type parameter of this tool .
Object	getOutFeatureclass() Returns the Output Feature Class parameter of this tool .
Object	getSpatialReference() Returns the Spatial Reference 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	getXField() Returns the X Field parameter of this tool .
Object	getYField() Returns the Y Field parameter of this tool .
void	setBearingField(Object bearingField) Sets the Bearing Field parameter of this tool .
void	setBearingUnits(String bearingUnits) Sets the Bearing Units parameter of this tool .
void	setDistanceField(Object distanceField) Sets the Distance Field parameter of this tool .
void	setDistanceUnits(String distanceUnits) Sets the Distance Units parameter of this tool .
void	setIdField(Object idField) Sets the ID parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setLineType(String lineType) Sets the Line Type parameter of this tool .
void	setOutFeatureclass(Object outFeatureclass) Sets the Output Feature Class parameter of this tool .
void	setSpatialReference(Object spatialReference) Sets the Spatial Reference parameter of this tool .
void	setXField(Object xField) Sets the X Field parameter of this tool .
void	setYField(Object yField) Sets the Y 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

BearingDistanceToLine

public BearingDistanceToLine()

Creates the Bearing Distance To Line tool with defaults.

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

BearingDistanceToLine

public BearingDistanceToLine(Object inTable,
                             Object outFeatureclass,
                             Object xField,
                             Object yField,
                             Object distanceField,
                             String distanceUnits,
                             Object bearingField,
                             String bearingUnits,
                             String lineType)

Creates the Bearing Distance To Line 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:

inTable - table containing input parameters to create two-point lines based on a bearing and distance. Each row creates one line feature.

outFeatureclass - output line feature class.

xField - input table field containing the x-values (longitude) of the starting point.

yField - input table field containing the y-values (latitude) of the starting point.

distanceField - field in the input table containing values of the length of the output line.

distanceUnits - units of measurement of the Distance field. The default is METERS.

bearingField - field in the input table containing direction values of the output line.

bearingUnits - units of measurement of the Bearing field. The default is DEGREES.

lineType - type of two-point lines to construct. The default line type is GEODESIC.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is table containing input parameters to create two-point lines based on a bearing and distance. Each row creates one line feature. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is table containing input parameters to create two-point lines based on a bearing and distance. Each row creates one line feature. This is a required parameter.

Parameters:

inTable - table containing input parameters to create two-point lines based on a bearing and distance. Each row creates one line feature.

getOutFeatureclass

public Object getOutFeatureclass()

Returns the Output Feature Class parameter of this tool . This parameter is output line feature class. 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 output line feature class. This is a required parameter.

Parameters:

outFeatureclass - output line feature class.

getXField

public Object getXField()

Returns the X Field parameter of this tool . This parameter is input table field containing the x-values (longitude) of the starting point. This is a required parameter.

Returns:

the X Field

setXField

public void setXField(Object xField)

Sets the X Field parameter of this tool . This parameter is input table field containing the x-values (longitude) of the starting point. This is a required parameter.

Parameters:

xField - input table field containing the x-values (longitude) of the starting point.

getYField

public Object getYField()

Returns the Y Field parameter of this tool . This parameter is input table field containing the y-values (latitude) of the starting point. This is a required parameter.

Returns:

the Y Field

setYField

public void setYField(Object yField)

Sets the Y Field parameter of this tool . This parameter is input table field containing the y-values (latitude) of the starting point. This is a required parameter.

Parameters:

yField - input table field containing the y-values (latitude) of the starting point.

getDistanceField

public Object getDistanceField()

Returns the Distance Field parameter of this tool . This parameter is field in the input table containing values of the length of the output line. This is a required parameter.

Returns:

the Distance Field

setDistanceField

public void setDistanceField(Object distanceField)

Sets the Distance Field parameter of this tool . This parameter is field in the input table containing values of the length of the output line. This is a required parameter.

Parameters:

distanceField - field in the input table containing values of the length of the output line.

getDistanceUnits

public String getDistanceUnits()

Returns the Distance Units parameter of this tool . This parameter is units of measurement of the Distance field. The default is METERS. This is a required parameter.

Returns:

the Distance Units

setDistanceUnits

public void setDistanceUnits(String distanceUnits)

Sets the Distance Units parameter of this tool . This parameter is units of measurement of the Distance field. The default is METERS. This is a required parameter.

Parameters:

distanceUnits - units of measurement of the Distance field. The default is METERS.

getBearingField

public Object getBearingField()

Returns the Bearing Field parameter of this tool . This parameter is field in the input table containing direction values of the output line. This is a required parameter.

Returns:

the Bearing Field

setBearingField

public void setBearingField(Object bearingField)

Sets the Bearing Field parameter of this tool . This parameter is field in the input table containing direction values of the output line. This is a required parameter.

Parameters:

bearingField - field in the input table containing direction values of the output line.

getBearingUnits

public String getBearingUnits()

Returns the Bearing Units parameter of this tool . This parameter is units of measurement of the Bearing field. The default is DEGREES. This is a required parameter.

Returns:

the Bearing Units

setBearingUnits

public void setBearingUnits(String bearingUnits)

Sets the Bearing Units parameter of this tool . This parameter is units of measurement of the Bearing field. The default is DEGREES. This is a required parameter.

Parameters:

bearingUnits - units of measurement of the Bearing field. The default is DEGREES.

getLineType

public String getLineType()

Returns the Line Type parameter of this tool . This parameter is type of two-point lines to construct. The default line type is GEODESIC. This is a required parameter.

Returns:

the Line Type

setLineType

public void setLineType(String lineType)

Sets the Line Type parameter of this tool . This parameter is type of two-point lines to construct. The default line type is GEODESIC. This is a required parameter.

Parameters:

lineType - type of two-point lines to construct. The default line type is GEODESIC.

getIdField

public Object getIdField()

Returns the ID parameter of this tool . This parameter is iD field from the input table. This can be used to join the output features to the input table. This is an optional parameter.

Returns:

the ID

setIdField

public void setIdField(Object idField)

Sets the ID parameter of this tool . This parameter is iD field from the input table. This can be used to join the output features to the input table. This is an optional parameter.

Parameters:

idField - iD field from the input table. This can be used to join the output features to the input table.

getSpatialReference

public Object getSpatialReference()

Returns the Spatial Reference parameter of this tool . This parameter is spatial reference of the starting point coordinates. The default is GCS_WGS_1984. This is an optional parameter.

Returns:

the Spatial Reference

setSpatialReference

public void setSpatialReference(Object spatialReference)

Sets the Spatial Reference parameter of this tool . This parameter is spatial reference of the starting point coordinates. The default is GCS_WGS_1984. This is an optional parameter.

Parameters:

spatialReference - spatial reference of the starting point coordinates. The default is GCS_WGS_1984.

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