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

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

All Implemented Interfaces:

GPTool

public class Ungenerate
extends AbstractGPTool

Creates a text file of x,y coordinates from the input coverage. The Ungenerate tool is contained in the Coverage Tools tool box.

Usage tips:

• Ungenerate provides a useful mechanism to create simple coordinate files from coverages. This allows you to easily transfer coverages to other mapping systems or view and update individual coordinates using your computer's text editor.
• The output text file is in a format that is readable by the Generate tool.
• User-IDs are written to the Output Generate File for lines, points, polygons, regions, and tics.
• All internal calculations are done in double precision regardless of the precision of the input or output dataset. Single-precision output is accurate to approximately seven significant digits. Ignore values beyond seven significant digits for ungenerated files in single precision. For accuracy to approximately 15 digits, use double precision.
• The coordinates created by Ungenerate are in the same coordinate precision as the Input Coverage. Single-precision coordinates are generated for single-precision coverages, and double-precision coordinates for double-precision coverages.
• For files created with the Region., further processing with the tool and the or tool is necessary to fully restore regions.
• When using the Poly option, polygons that are not properly closed will not be written to the Output file. If there are two label points in one polygon, only one will be written. If no label point exists, then zero is written for the ID number of that polygon feature, and the x,y coordinate for the centroid will be written.
• Ungenerate writes a flag for island polygons. The island polygon will have an ID number of -99999 and a set of vertices defining the polygon. This is useful for converting ArcInfo polygon coverages to other systems that require special handling of island polygons.
• The Poly option treats all line segments that are wholly contained within a polygon as island polygons and tags them with an ID number of -99999. Line segments that fall inside the polygon but touch the border of the polygon are also considered islands inside the polygon. However, line segments that fall outside a polygon are considered part of the universe polygon and are ignored.
• All vertices that define each component arc of a polygon feature will be written. To weed out vertices of very dense coverages, use the tool prior to using the Generate tool. The arcs for each polygon are written starting at the lower left of the polygon and continuing in a clockwise direction. Arcs that are shared by more than one polygon will be duplicated in the output file. Nodes and arc orientation are not preserved.
• When using the ANNO option, the annotations within a specified class will be written to a file in the following format. All the annotation shape points up to 500 will be written.
• It is important to note that the above format for Ungenerate annotation is not compatible with the format expected by the Generate command. Its main use is to provide a simple way to translate annotation to a different format.

Field Summary

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

vals

Constructor Summary

Ungenerate()
Creates the Ungenerate tool with defaults.

Ungenerate(java.lang.Object inCover, java.lang.Object outGenerateFile, java.lang.String featureType)
Creates the Ungenerate tool with the required parameters.

Method Summary

java.lang.String	getDuplicateNodes() Returns the Duplicate Nodes parameter of this tool .
java.lang.String	getFeatureType() Returns the Feature Type parameter of this tool .
java.lang.String	getFormat() Returns the Numeric Format parameter of this tool .
java.lang.Object	getInCover() Returns the Input Coverage parameter of this tool .
java.lang.Object	getOutGenerateFile() Returns the Output Generate File parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setDuplicateNodes(java.lang.String duplicateNodes) Sets the Duplicate Nodes parameter of this tool .
void	setFeatureType(java.lang.String featureType) Sets the Feature Type parameter of this tool .
void	setFormat(java.lang.String format) Sets the Numeric Format parameter of this tool .
void	setInCover(java.lang.Object inCover) Sets the Input Coverage parameter of this tool .
void	setOutGenerateFile(java.lang.Object outGenerateFile) Sets the Output Generate File 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

Ungenerate

public Ungenerate()

Creates the Ungenerate tool with defaults.

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

Ungenerate

public Ungenerate(java.lang.Object inCover,
                  java.lang.Object outGenerateFile,
                  java.lang.String featureType)

Creates the Ungenerate 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 from which feature coordinates will be written.

outGenerateFile - the text file to which the x,y coordinates will be written.

featureType - the type of features that will be used in the generation of the output file.

Method Detail

getInCover

public java.lang.Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is the coverage from which feature coordinates will be written. This is a required parameter.

Returns:

the Input Coverage

setInCover

public void setInCover(java.lang.Object inCover)

Sets the Input Coverage parameter of this tool . This parameter is the coverage from which feature coordinates will be written. This is a required parameter.

Parameters:

inCover - the coverage from which feature coordinates will be written.

getOutGenerateFile

public java.lang.Object getOutGenerateFile()

Returns the Output Generate File parameter of this tool . This parameter is the text file to which the x,y coordinates will be written. This is a required parameter.

Returns:

the Output Generate File

setOutGenerateFile

public void setOutGenerateFile(java.lang.Object outGenerateFile)

Sets the Output Generate File parameter of this tool . This parameter is the text file to which the x,y coordinates will be written. This is a required parameter.

Parameters:

outGenerateFile - the text file to which the x,y coordinates will be written.

getFeatureType

public java.lang.String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is the type of features that will be used in the generation of the output file. This is a required parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(java.lang.String featureType)

Sets the Feature Type parameter of this tool . This parameter is the type of features that will be used in the generation of the output file. This is a required parameter.

Parameters:

featureType - the type of features that will be used in the generation of the output file.

getDuplicateNodes

public java.lang.String getDuplicateNodes()

Returns the Duplicate Nodes parameter of this tool . This parameter is determines whether duplicate node coordinates will be retained or dropped in the Output Generate File. This applies only to the POLY option. This is an optional parameter.

Returns:

the Duplicate Nodes

setDuplicateNodes

public void setDuplicateNodes(java.lang.String duplicateNodes)

Sets the Duplicate Nodes parameter of this tool . This parameter is determines whether duplicate node coordinates will be retained or dropped in the Output Generate File. This applies only to the POLY option. This is an optional parameter.

Parameters:

duplicateNodes - determines whether duplicate node coordinates will be retained or dropped in the Output Generate File. This applies only to the POLY option.

getFormat

public java.lang.String getFormat()

Returns the Numeric Format parameter of this tool . This parameter is selects either exponential or fixed representation of floating point numbers in the Output Generate File. This is an optional parameter.

Returns:

the Numeric Format

setFormat

public void setFormat(java.lang.String format)

Sets the Numeric Format parameter of this tool . This parameter is selects either exponential or fixed representation of floating point numbers in the Output Generate File. This is an optional parameter.

Parameters:

format - selects either exponential or fixed representation of floating point numbers in the Output Generate File.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias