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

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

All Implemented Interfaces:

GPTool

public class ExportCAD
extends AbstractGPTool

Creates one or more CAD drawings based on the values contained in one or more input feature classes or feature layers and supporting tables. The Export to CAD tool is contained in the Conversion Tools tool box.

Usage tips:

• All input feature classes and/or feature layers and shapefiles are valid inputs to this tool.
• This tool creates DWG, DXF, or DGN CAD files.
• This tool will not export coverage annotation to any CAD format.
• By default, CAD entities are generated using the default entity properties of the target CAD file format unless otherwise specified using seed files and/or key named fields.
• Seed files and key named fields can be used to control layers, CAD entity properties, and cell or block definitions in the destination CAD file(s).
• The tool can be used to add the key named fields recognized by to specify CAD entity properties. Alternatively, can be used to add only the field(s) needed for a specific task.
• The RefName field in the input feature class specifies which seed file block or cell names to use. Further, attribute tag elements defined within the block or cell will be populated with attribute information if their tag names match a field name or field alias.
• The DocPath field in the input feature class is used to direct the output to one or more CAD drawing files. Export To CAD will ignore this field unless the parameter Ignore Paths in Tables is unchecked in the tool dialog box or command line function.
• The LTScale field is used to adjust the line weight in DGN files.
• The LineWt field is used to adjust the line weight in DWG files.
• This tool will export annotation feature classes to CAD files as text. Conversely, the tool supports the creation of annotation feature classes.
• Output To DWG/DXF also exports the coordinate system, a feature class schema that defines the CAD feature classes, and the attribute information. This information is embedded in the DWG and organized by feature class name or values of the layer field in the input feature class (for example, highways, hydrants, or flooded areas). Subsequently, ArcGIS will read this embedded information and enable the ArcGIS user to process this read-only CAD information similarly to standard CAD feature classes. Reference the ESRI Mapping Specification for DWG (MSD) for in-depth information regarding this encoding format.

Field Summary

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

vals

Constructor Summary

ExportCAD()
Creates the Export to CAD tool with defaults.

ExportCAD(Object inFeatures, String outputType, Object outputFile)
Creates the Export to CAD tool with the required parameters.

Method Summary

String	getAppendToExisting() Returns the Append to Existing Files parameter of this tool .
String	getIgnoreFileNames() Returns the Ignore Paths in Tables parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutputFile() Returns the Output File parameter of this tool .
String	getOutputType() Returns the Output Type parameter of this tool .
Object	getSeedFile() Returns the Seed 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.
void	setAppendToExisting(String appendToExisting) Sets the Append to Existing Files parameter of this tool .
void	setIgnoreFileNames(String ignoreFileNames) Sets the Ignore Paths in Tables parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutputFile(Object outputFile) Sets the Output File parameter of this tool .
void	setOutputType(String outputType) Sets the Output Type parameter of this tool .
void	setSeedFile(Object seedFile) Sets the Seed 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

ExportCAD

public ExportCAD()

Creates the Export to CAD tool with defaults.

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

ExportCAD

public ExportCAD(Object inFeatures,
                 String outputType,
                 Object outputFile)

Creates the Export to CAD 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 - a collection of feature classes and/or feature layers whose geometry will be exported to one or more CAD files.

outputType - the CAD platform and file version of the output files. This value overrides any output_type values contained in the keyname column or alias column CADFile_type. Types include DGN-V8, DWG-R14, DWG-R2000, DWG-R2004, DWG-R2005, DWG-R2006, DWG-R2007, DWG-R2010, DXF-R14, DXF-R2000, DXF-R2004, DXF-R2005, DXF-R2006, DXF-R2007, and DXF-R2010.

outputFile - the path of the desired output CAD drawing file. This name overrides any drawing name information included in the input features columns or alias columns named DrawingPathName.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is a collection of feature classes and/or feature layers whose geometry will be exported to one or more CAD files. 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 a collection of feature classes and/or feature layers whose geometry will be exported to one or more CAD files. This is a required parameter.

Parameters:

inFeatures - a collection of feature classes and/or feature layers whose geometry will be exported to one or more CAD files.

getOutputType

public String getOutputType()

Returns the Output Type parameter of this tool . This parameter is the CAD platform and file version of the output files. This value overrides any output_type values contained in the keyname column or alias column CADFile_type. Types include DGN-V8, DWG-R14, DWG-R2000, DWG-R2004, DWG-R2005, DWG-R2006, DWG-R2007, DWG-R2010, DXF-R14, DXF-R2000, DXF-R2004, DXF-R2005, DXF-R2006, DXF-R2007, and DXF-R2010. This is a required parameter.

Returns:

the Output Type

setOutputType

public void setOutputType(String outputType)

Sets the Output Type parameter of this tool . This parameter is the CAD platform and file version of the output files. This value overrides any output_type values contained in the keyname column or alias column CADFile_type. Types include DGN-V8, DWG-R14, DWG-R2000, DWG-R2004, DWG-R2005, DWG-R2006, DWG-R2007, DWG-R2010, DXF-R14, DXF-R2000, DXF-R2004, DXF-R2005, DXF-R2006, DXF-R2007, and DXF-R2010. This is a required parameter.

Parameters:

outputType - the CAD platform and file version of the output files. This value overrides any output_type values contained in the keyname column or alias column CADFile_type. Types include DGN-V8, DWG-R14, DWG-R2000, DWG-R2004, DWG-R2005, DWG-R2006, DWG-R2007, DWG-R2010, DXF-R14, DXF-R2000, DXF-R2004, DXF-R2005, DXF-R2006, DXF-R2007, and DXF-R2010.

getOutputFile

public Object getOutputFile()

Returns the Output File parameter of this tool . This parameter is the path of the desired output CAD drawing file. This name overrides any drawing name information included in the input features columns or alias columns named DrawingPathName. This is a required parameter.

Returns:

the Output File

setOutputFile

public void setOutputFile(Object outputFile)

Sets the Output File parameter of this tool . This parameter is the path of the desired output CAD drawing file. This name overrides any drawing name information included in the input features columns or alias columns named DrawingPathName. This is a required parameter.

Parameters:

outputFile - the path of the desired output CAD drawing file. This name overrides any drawing name information included in the input features columns or alias columns named DrawingPathName.

getIgnoreFileNames

public String getIgnoreFileNames()

Returns the Ignore Paths in Tables parameter of this tool . This parameter is allows the function to ignore or use the paths in the DrawingPathName. This allows the function to output CAD entities to specific drawings or ignore this and add to one CAD file. This is an optional parameter.

Returns:

the Ignore Paths in Tables

setIgnoreFileNames

public void setIgnoreFileNames(String ignoreFileNames)

Sets the Ignore Paths in Tables parameter of this tool . This parameter is allows the function to ignore or use the paths in the DrawingPathName. This allows the function to output CAD entities to specific drawings or ignore this and add to one CAD file. This is an optional parameter.

Parameters:

ignoreFileNames - allows the function to ignore or use the paths in the DrawingPathName. This allows the function to output CAD entities to specific drawings or ignore this and add to one CAD file.

getAppendToExisting

public String getAppendToExisting()

Returns the Append to Existing Files parameter of this tool . This parameter is allows the output to append to an existing CAD file. This lets you add information to a CAD file on disk. This is an optional parameter.

Returns:

the Append to Existing Files

setAppendToExisting

public void setAppendToExisting(String appendToExisting)

Sets the Append to Existing Files parameter of this tool . This parameter is allows the output to append to an existing CAD file. This lets you add information to a CAD file on disk. This is an optional parameter.

Parameters:

appendToExisting - allows the output to append to an existing CAD file. This lets you add information to a CAD file on disk.

getSeedFile

public Object getSeedFile()

Returns the Seed File parameter of this tool . This parameter is an existing CAD drawing whose contents and document and layer properties will be used for all new output CAD files. If appending to existing CAD files, the seed drawing is ignored. This is an optional parameter.

Returns:

the Seed File

setSeedFile

public void setSeedFile(Object seedFile)

Sets the Seed File parameter of this tool . This parameter is an existing CAD drawing whose contents and document and layer properties will be used for all new output CAD files. If appending to existing CAD files, the seed drawing is ignored. This is an optional parameter.

Parameters:

seedFile - an existing CAD drawing whose contents and document and layer properties will be used for all new output CAD files. If appending to existing CAD files, the seed drawing is ignored.

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