com.esri.arcgis.geoprocessing.tools.coveragetools
Class ArcDLG

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.ArcDLG

All Implemented Interfaces:

GPTool

public class ArcDLG
extends AbstractGPTool

Creates a Digital Line Graph from a coverage. The DLG is output in DLG-3 Optional (as opposed to Standard) format. The Export To DLG tool is contained in the Coverage Tools tool box.

Usage tips:

• Before creating a DLG file using Export To DLG, each node should be sequentially numbered using the . This will ensure that all arc, node, and polygon feature internal numbers are sequential.
• There are two distribution formats for a DLG file: Standard and Optional. This tool writes a DLG in the Optional format only.
• The reads and converts Standard or Optional DLG files into a coverage.
• To create a DLG file that contains only point features, you should specify an input coverage that contains one rectangular polygon defining the area covered by the points. Use the name of the point coverage for the Point Coverage option.
• Only one DLG category or layer can be saved in a DLG file created by Export To DLG. A DLG category is equivalent to a layer in a map.
• The internal feature numbers (cover#) are written as the output DLG feature numbers.
• Coverage topology is saved in the DLG file using conventions that are similar to the way topology is stored in a coverage (for example, polygons are defined in clockwise loops, islands as counterclockwise loops; each feature has a unique identification number;and negative numbers for lines indicate reverse directions).

Field Summary

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

vals

Constructor Summary

ArcDLG()
Creates the Export To DLG tool with defaults.

ArcDLG(Object inCover, Object outDlgFile)
Creates the Export To DLG tool with the required parameters.

Method Summary

Object	getInCover() Returns the Input Coverage parameter of this tool .
Object	getInHeaderFile() Returns the Header File parameter of this tool .
Object	getInPointCover() Returns the Point Coverage parameter of this tool .
Object	getInProjectionFile() Returns the Projection File parameter of this tool .
Object	getOutDlgFile() Returns the Output DLG File 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.
String	getTransform() Returns the Transform Coordinates parameter of this tool .
double	getXShift() Returns the X Shift parameter of this tool .
double	getYShift() Returns the Y Shift parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setInHeaderFile(Object inHeaderFile) Sets the Header File parameter of this tool .
void	setInPointCover(Object inPointCover) Sets the Point Coverage parameter of this tool .
void	setInProjectionFile(Object inProjectionFile) Sets the Projection File parameter of this tool .
void	setOutDlgFile(Object outDlgFile) Sets the Output DLG File parameter of this tool .
void	setTransform(String transform) Sets the Transform Coordinates parameter of this tool .
void	setXShift(double xShift) Sets the X Shift parameter of this tool .
void	setYShift(double yShift) Sets the Y Shift 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

ArcDLG

public ArcDLG()

Creates the Export To DLG tool with defaults.

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

ArcDLG

public ArcDLG(Object inCover,
              Object outDlgFile)

Creates the Export To DLG 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:

inCover - the coverage to be converted to DLG format. It may contain polygon, line, and node features.

outDlgFile - the output DLG-3 Optional format file to be created.

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage to be converted to DLG format. It may contain polygon, line, and node features. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage to be converted to DLG format. It may contain polygon, line, and node features. This is a required parameter.

Parameters:

inCover - the coverage to be converted to DLG format. It may contain polygon, line, and node features.

getOutDlgFile

public Object getOutDlgFile()

Returns the Output DLG File parameter of this tool . This parameter is the output DLG-3 Optional format file to be created. This is a required parameter.

Returns:

the Output DLG File

setOutDlgFile

public void setOutDlgFile(Object outDlgFile)

Sets the Output DLG File parameter of this tool . This parameter is the output DLG-3 Optional format file to be created. This is a required parameter.

Parameters:

outDlgFile - the output DLG-3 Optional format file to be created.

getInPointCover

public Object getInPointCover()

Returns the Point Coverage parameter of this tool . This parameter is a coverage containing point features to be written as zero length, degenerate Line (L) records in the output DLG. This is an optional parameter.

Returns:

the Point Coverage

setInPointCover

public void setInPointCover(Object inPointCover)

Sets the Point Coverage parameter of this tool . This parameter is a coverage containing point features to be written as zero length, degenerate Line (L) records in the output DLG. This is an optional parameter.

Parameters:

inPointCover - a coverage containing point features to be written as zero length, degenerate Line (L) records in the output DLG.

getInProjectionFile

public Object getInProjectionFile()

Returns the Projection File parameter of this tool . This parameter is a text file containing input projection parameters to be saved in the DLG header. This is an optional parameter.

Returns:

the Projection File

setInProjectionFile

public void setInProjectionFile(Object inProjectionFile)

Sets the Projection File parameter of this tool . This parameter is a text file containing input projection parameters to be saved in the DLG header. This is an optional parameter.

Parameters:

inProjectionFile - a text file containing input projection parameters to be saved in the DLG header.

getXShift

public double getXShift()

Returns the X Shift parameter of this tool . This parameter is a constant value to be added to all coverage x-coordinates during the conversion to DLG. X Shift overrides any x-shift parameters found in either projection file or input cover projection definition file. If a value for X Shift is not specified, the default is zero. This is an optional parameter.

Returns:

the X Shift

setXShift

public void setXShift(double xShift)

Sets the X Shift parameter of this tool . This parameter is a constant value to be added to all coverage x-coordinates during the conversion to DLG. X Shift overrides any x-shift parameters found in either projection file or input cover projection definition file. If a value for X Shift is not specified, the default is zero. This is an optional parameter.

Parameters:

xShift - a constant value to be added to all coverage x-coordinates during the conversion to DLG. X Shift overrides any x-shift parameters found in either projection file or input cover projection definition file. If a value for X Shift is not specified, the default is zero.

getYShift

public double getYShift()

Returns the Y Shift parameter of this tool . This parameter is a constant value to be added to all y-coordinates during conversion to DLG. Y Shift overrides any y-shift parameters found in either the projection file or input cover projection definition file. If a value for Y Shift is not specified, the default is zero. This is an optional parameter.

Returns:

the Y Shift

setYShift

public void setYShift(double yShift)

Sets the Y Shift parameter of this tool . This parameter is a constant value to be added to all y-coordinates during conversion to DLG. Y Shift overrides any y-shift parameters found in either the projection file or input cover projection definition file. If a value for Y Shift is not specified, the default is zero. This is an optional parameter.

Parameters:

yShift - a constant value to be added to all y-coordinates during conversion to DLG. Y Shift overrides any y-shift parameters found in either the projection file or input cover projection definition file. If a value for Y Shift is not specified, the default is zero.

getInHeaderFile

public Object getInHeaderFile()

Returns the Header File parameter of this tool . This parameter is the file containing information to be written into the header of the DLG file. This is an optional parameter.

Returns:

the Header File

setInHeaderFile

public void setInHeaderFile(Object inHeaderFile)

Sets the Header File parameter of this tool . This parameter is the file containing information to be written into the header of the DLG file. This is an optional parameter.

Parameters:

inHeaderFile - the file containing information to be written into the header of the DLG file.

getTransform

public String getTransform()

Returns the Transform Coordinates parameter of this tool . This parameter is this operation controls whether a coordinate transformation is performed. Usually, coordinates are transformed to preserve accuracy when written to the DLG. This is an optional parameter.

Returns:

the Transform Coordinates

setTransform

public void setTransform(String transform)

Sets the Transform Coordinates parameter of this tool . This parameter is this operation controls whether a coordinate transformation is performed. Usually, coordinates are transformed to preserve accuracy when written to the DLG. This is an optional parameter.

Parameters:

transform - this operation controls whether a coordinate transformation is performed. Usually, coordinates are transformed to preserve accuracy when written to the DLG.

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