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

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

public class Intersect3DLineWithMultiPatch
extends AbstractGPTool

Computes a geometric intersection of the input line and multipatch features, and returns the number of points of intersection. Points (of intersection) and/or lines (resulting from input lines being broken at intersection points) can optionally be written to output feature class(es). The Intersect 3D Line With Multipatch tool is contained in the 3D Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Intersect3DLineWithMultiPatch()
          Creates the Intersect 3D Line With Multipatch tool with defaults.
Intersect3DLineWithMultiPatch(Object inLineFeatures, Object inMultipatchFeatures)
          Creates the Intersect 3D Line With Multipatch tool with the required parameters.
 
Method Summary
 Object getInLineFeatures()
          Returns the Input Line Features parameter of this tool .
 Object getInMultipatchFeatures()
          Returns the Input Multipatch Features parameter of this tool .
 String getJoinAttributes()
          Returns the Join Attributes parameter of this tool .
 int getOutIntersectionCount()
          Returns the Intersection Count parameter of this tool (Read only).
 Object getOutLineFeatureClass()
          Returns the Output Line Feature Class parameter of this tool .
 Object getOutPointFeatureClass()
          Returns the Output Point Feature Class 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 setInLineFeatures(Object inLineFeatures)
          Sets the Input Line Features parameter of this tool .
 void setInMultipatchFeatures(Object inMultipatchFeatures)
          Sets the Input Multipatch Features parameter of this tool .
 void setJoinAttributes(String joinAttributes)
          Sets the Join Attributes parameter of this tool .
 void setOutLineFeatureClass(Object outLineFeatureClass)
          Sets the Output Line Feature Class parameter of this tool .
 void setOutPointFeatureClass(Object outPointFeatureClass)
          Sets the Output Point Feature Class 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

Intersect3DLineWithMultiPatch

public Intersect3DLineWithMultiPatch()
Creates the Intersect 3D Line With Multipatch tool with defaults.

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


Intersect3DLineWithMultiPatch

public Intersect3DLineWithMultiPatch(Object inLineFeatures,
                                     Object inMultipatchFeatures)
Creates the Intersect 3D Line With Multipatch 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:
inLineFeatures - the input line feature class or layer.
inMultipatchFeatures - the input multipatch feature class or layer.
Method Detail

getInLineFeatures

public Object getInLineFeatures()
Returns the Input Line Features parameter of this tool . This parameter is the input line feature class or layer. This is a required parameter.

Returns:
the Input Line Features

setInLineFeatures

public void setInLineFeatures(Object inLineFeatures)
Sets the Input Line Features parameter of this tool . This parameter is the input line feature class or layer. This is a required parameter.

Parameters:
inLineFeatures - the input line feature class or layer.

getInMultipatchFeatures

public Object getInMultipatchFeatures()
Returns the Input Multipatch Features parameter of this tool . This parameter is the input multipatch feature class or layer. This is a required parameter.

Returns:
the Input Multipatch Features

setInMultipatchFeatures

public void setInMultipatchFeatures(Object inMultipatchFeatures)
Sets the Input Multipatch Features parameter of this tool . This parameter is the input multipatch feature class or layer. This is a required parameter.

Parameters:
inMultipatchFeatures - the input multipatch feature class or layer.

getJoinAttributes

public String getJoinAttributes()
Returns the Join Attributes parameter of this tool . This parameter is allows all nonrequired fields (in other words, not ObjectID or geometry) and values from the input line feature class to be copied into the optional output line feature class. This is an optional parameter.

Returns:
the Join Attributes

setJoinAttributes

public void setJoinAttributes(String joinAttributes)
Sets the Join Attributes parameter of this tool . This parameter is allows all nonrequired fields (in other words, not ObjectID or geometry) and values from the input line feature class to be copied into the optional output line feature class. This is an optional parameter.

Parameters:
joinAttributes - allows all nonrequired fields (in other words, not ObjectID or geometry) and values from the input line feature class to be copied into the optional output line feature class.

getOutPointFeatureClass

public Object getOutPointFeatureClass()
Returns the Output Point Feature Class parameter of this tool . This parameter is the optional feature class into which points of intersection will be placed. This is an optional parameter.

Returns:
the Output Point Feature Class

setOutPointFeatureClass

public void setOutPointFeatureClass(Object outPointFeatureClass)
Sets the Output Point Feature Class parameter of this tool . This parameter is the optional feature class into which points of intersection will be placed. This is an optional parameter.

Parameters:
outPointFeatureClass - the optional feature class into which points of intersection will be placed.

getOutLineFeatureClass

public Object getOutLineFeatureClass()
Returns the Output Line Feature Class parameter of this tool . This parameter is the optional feature class into which lines (input lines broken at points of intersection) will be placed. This is an optional parameter.

Returns:
the Output Line Feature Class

setOutLineFeatureClass

public void setOutLineFeatureClass(Object outLineFeatureClass)
Sets the Output Line Feature Class parameter of this tool . This parameter is the optional feature class into which lines (input lines broken at points of intersection) will be placed. This is an optional parameter.

Parameters:
outLineFeatureClass - the optional feature class into which lines (input lines broken at points of intersection) will be placed.

getOutIntersectionCount

public int getOutIntersectionCount()
Returns the Intersection Count parameter of this tool (Read only). This is an derived parameter.

Returns:
the Intersection Count

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