com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class LandXMLToTin

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.LandXMLToTin

All Implemented Interfaces:

GPTool

public class LandXMLToTin
extends AbstractGPTool

This tool imports one or more triangulated irregular network (TIN) surfaces from a LandXML file and writes the TIN(s) to location on disk. The LandXML to TIN tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Once the input LandXML file has been selected, the TINs to import parameter is populated with all the TIN surfaces found in the LandXML file.
• If several TINs are selected to be output, they would be named in the following manner: , 2, 3, and so on. If already exists, the tool will not write anything. If does not exist but 2 exists, the tool will create and 2_1, instead of 2.
• If the TINs are not Delaunay conforming the tool outputs contstrained Delaunay TIN(s).
• In script mode, the names inside the tinnames parameter can be specified in short form (only number or only name) for user convenience. Instead of "1. Site0445; 2. ; 3. ; 4. Site_09", you can specify: "1;2;3;4" or "Site0445; Site_09;2;3", but not ";;1;4" since is not unique.

Field Summary

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

vals

Constructor Summary

LandXMLToTin()
Creates the LandXML to TIN tool with defaults.

LandXMLToTin(Object inLandxmlPath, Object outTinFolder, String tinBasename)
Creates the LandXML to TIN tool with the required parameters.

Method Summary

Object	getDerivedTinFolder() Returns the Output TIN folder parameter of this tool (Read only).
Object	getInLandxmlPath() Returns the Input parameter of this tool .
Object	getOutTinFolder() Returns the Output TIN folder parameter of this tool .
String	getTinBasename() Returns the Output TIN base name parameter of this tool .
Object	getTinnames() Returns the TINs to import 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	setInLandxmlPath(Object inLandxmlPath) Sets the Input parameter of this tool .
void	setOutTinFolder(Object outTinFolder) Sets the Output TIN folder parameter of this tool .
void	setTinBasename(String tinBasename) Sets the Output TIN base name parameter of this tool .
void	setTinnames(Object tinnames) Sets the TINs to import 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

LandXMLToTin

public LandXMLToTin()

Creates the LandXML to TIN tool with defaults.

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

LandXMLToTin

public LandXMLToTin(Object inLandxmlPath,
                    Object outTinFolder,
                    String tinBasename)

Creates the LandXML to TIN 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:

inLandxmlPath - the location of the LandXML file.

outTinFolder - the folder where output files will be created.

tinBasename - the name of the TIN(s) to be output.

Method Detail

getInLandxmlPath

public Object getInLandxmlPath()

Returns the Input parameter of this tool . This parameter is the location of the LandXML file. This is a required parameter.

Returns:

the Input

setInLandxmlPath

public void setInLandxmlPath(Object inLandxmlPath)

Sets the Input parameter of this tool . This parameter is the location of the LandXML file. This is a required parameter.

Parameters:

inLandxmlPath - the location of the LandXML file.

getOutTinFolder

public Object getOutTinFolder()

Returns the Output TIN folder parameter of this tool . This parameter is the folder where output files will be created. This is a required parameter.

Returns:

the Output TIN folder

setOutTinFolder

public void setOutTinFolder(Object outTinFolder)

Sets the Output TIN folder parameter of this tool . This parameter is the folder where output files will be created. This is a required parameter.

Parameters:

outTinFolder - the folder where output files will be created.

getTinBasename

public String getTinBasename()

Returns the Output TIN base name parameter of this tool . This parameter is the name of the TIN(s) to be output. This is a required parameter.

Returns:

the Output TIN base name

setTinBasename

public void setTinBasename(String tinBasename)

Sets the Output TIN base name parameter of this tool . This parameter is the name of the TIN(s) to be output. This is a required parameter.

Parameters:

tinBasename - the name of the TIN(s) to be output.

getTinnames

public Object getTinnames()

Returns the TINs to import parameter of this tool . This parameter is if the LandXML contains more than one TIN, selects which one(s) to import. This is an optional parameter.

Returns:

the TINs to import

setTinnames

public void setTinnames(Object tinnames)

Sets the TINs to import parameter of this tool . This parameter is if the LandXML contains more than one TIN, selects which one(s) to import. This is an optional parameter.

Parameters:

tinnames - if the LandXML contains more than one TIN, selects which one(s) to import.

getDerivedTinFolder

public Object getDerivedTinFolder()

Returns the Output TIN folder parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output TIN folder

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