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

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

All Implemented Interfaces:

GPTool

public class Inside3D
extends AbstractGPTool

Tests each feature to determine if it falls inside a multipatch. If it falls inside a feature, it writes an entry to a new table indicating which feature it fell within. The Inside 3D tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Requires input features, which must have closed multipatch geometry.
• Only closed multipatches will be used in the test process.
• A feature may fall within multiple closed multipatch features and have multiple entries in the output table.
• Inside 3D is a 3D set operator as part of the 3D Features toolset. See for more information on what set operators are and how to use them.

Field Summary

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

vals

Constructor Summary

Inside3D()
Creates the Inside 3D tool with defaults.

Inside3D(Object inTargetFeatureClass, Object inContainerFeatureClass, Object outTable)
Creates the Inside 3D tool with the required parameters.

Method Summary

String	getComplexOutput() Returns the Complex Output Table parameter of this tool .
Object	getInContainerFeatureClass() Returns the Input Multipatch Features parameter of this tool .
Object	getInTargetFeatureClass() Returns the Input Features parameter of this tool .
Object	getOutTable() Returns the Output Table 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	setComplexOutput(String complexOutput) Sets the Complex Output Table parameter of this tool .
void	setInContainerFeatureClass(Object inContainerFeatureClass) Sets the Input Multipatch Features parameter of this tool .
void	setInTargetFeatureClass(Object inTargetFeatureClass) Sets the Input Features parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table 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

Inside3D

public Inside3D()

Creates the Inside 3D tool with defaults.

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

Inside3D

public Inside3D(Object inTargetFeatureClass,
                Object inContainerFeatureClass,
                Object outTable)

Creates the Inside 3D 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:

inTargetFeatureClass - the z-enabled point, line, polygon, or multipatch features.

inContainerFeatureClass - the multipatch features.

outTable - null

Method Detail

getInTargetFeatureClass

public Object getInTargetFeatureClass()

Returns the Input Features parameter of this tool . This parameter is the z-enabled point, line, polygon, or multipatch features. This is a required parameter.

Returns:

the Input Features

setInTargetFeatureClass

public void setInTargetFeatureClass(Object inTargetFeatureClass)

Sets the Input Features parameter of this tool . This parameter is the z-enabled point, line, polygon, or multipatch features. This is a required parameter.

Parameters:

inTargetFeatureClass - the z-enabled point, line, polygon, or multipatch features.

getInContainerFeatureClass

public Object getInContainerFeatureClass()

Returns the Input Multipatch Features parameter of this tool . This parameter is the multipatch features. This is a required parameter.

Returns:

the Input Multipatch Features

setInContainerFeatureClass

public void setInContainerFeatureClass(Object inContainerFeatureClass)

Sets the Input Multipatch Features parameter of this tool . This parameter is the multipatch features. This is a required parameter.

Parameters:

inContainerFeatureClass - the multipatch features.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This is a required parameter.

Returns:

the Output Table

setOutTable

public void setOutTable(Object outTable)

Sets the Output Table parameter of this tool . This is a required parameter.

Parameters:

outTable - null

getComplexOutput

public String getComplexOutput()

Returns the Complex Output Table parameter of this tool . This parameter is the table to be created that contains the relationship between input features. This is an optional parameter.

Returns:

the Complex Output Table

setComplexOutput

public void setComplexOutput(String complexOutput)

Sets the Complex Output Table parameter of this tool . This parameter is the table to be created that contains the relationship between input features. This is an optional parameter.

Parameters:

complexOutput - the table to be created that contains the relationship between input features.

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