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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.conversiontools.ExportCAD
All Implemented Interfaces:
GPTool

public class ExportCAD
extends AbstractGPTool

This function will create 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.
Learn more about how Export CAD works

Software restrictions: ArcInfo only

Usage tips:


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 - Feature Layer, a collection of feature classes and/or feature layers whose geometry will be exported to one or more CAD files.
outputType - String, 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, DXF-R14, DXF-R2000, DXF-R2004. DXF-R2005, DXF-R2006, DXF-R2007.
outputFile - CAD Drawing Dataset, the pathname 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 Feature Layer, 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 Feature Layer, 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 - Feature Layer, 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 String, 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, DXF-R14, DXF-R2000, DXF-R2004. DXF-R2005, DXF-R2006, DXF-R2007. 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 String, 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, DXF-R14, DXF-R2000, DXF-R2004. DXF-R2005, DXF-R2006, DXF-R2007. This is a required parameter.

Parameters:
outputType - String, 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, DXF-R14, DXF-R2000, DXF-R2004. DXF-R2005, DXF-R2006, DXF-R2007.

getOutputFile

public Object getOutputFile()
Returns the Output File parameter of this tool . This parameter is CAD Drawing Dataset, the pathname 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 CAD Drawing Dataset, the pathname 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 - CAD Drawing Dataset, the pathname 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 String, allows the function to ignore or use the pathnames in the "DrawingPathName". This allows the function to output CAD entities to specific drawings or to 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 String, allows the function to ignore or use the pathnames in the "DrawingPathName". This allows the function to output CAD entities to specific drawings or to ignore this and add to one CAD file. This is an optional parameter.

Parameters:
ignoreFileNames - String, allows the function to ignore or use the pathnames in the "DrawingPathName". This allows the function to output CAD entities to specific drawings or to 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 String, allows the output to append to an existing CAD file. This allows you to 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 String, allows the output to append to an existing CAD file. This allows you to add information to a CAD file on disk. This is an optional parameter.

Parameters:
appendToExisting - String, allows the output to append to an existing CAD file. This allows you to add information to a CAD file on disk.

getSeedFile

public Object getSeedFile()
Returns the Seed File parameter of this tool . This parameter is CAD Drawing Dataset, an existing CAD drawing whose contents, 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 CAD Drawing Dataset, an existing CAD drawing whose contents, 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 - CAD Drawing Dataset, an existing CAD drawing whose contents, 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