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

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

public class ConstructSightLines
extends AbstractGPTool

Constructs lines between each of the observer points and each of the target features. The Construct Sight Lines 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
ConstructSightLines()
          Creates the Construct Sight Lines tool with defaults.
ConstructSightLines(Object inObserverPoints, Object inTargetFeatures, Object outLineFeatureClass)
          Creates the Construct Sight Lines tool with the required parameters.
 
Method Summary
 Object getInObserverPoints()
          Returns the Observer Points parameter of this tool .
 Object getInTargetFeatures()
          Returns the Target Features parameter of this tool .
 String getJoinField()
          Returns the Join Field parameter of this tool .
 String getObserverHeightField()
          Returns the Observer Height Field parameter of this tool .
 Object getOutLineFeatureClass()
          Returns the Output parameter of this tool .
 double getSampleDistance()
          Returns the Sampling Distance parameter of this tool .
 String getTargetHeightField()
          Returns the Target Height Field 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 setInObserverPoints(Object inObserverPoints)
          Sets the Observer Points parameter of this tool .
 void setInTargetFeatures(Object inTargetFeatures)
          Sets the Target Features parameter of this tool .
 void setJoinField(String joinField)
          Sets the Join Field parameter of this tool .
 void setObserverHeightField(String observerHeightField)
          Sets the Observer Height Field parameter of this tool .
 void setOutLineFeatureClass(Object outLineFeatureClass)
          Sets the Output parameter of this tool .
 void setSampleDistance(double sampleDistance)
          Sets the Sampling Distance parameter of this tool .
 void setTargetHeightField(String targetHeightField)
          Sets the Target Height Field 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

ConstructSightLines

public ConstructSightLines()
Creates the Construct Sight Lines tool with defaults.

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


ConstructSightLines

public ConstructSightLines(Object inObserverPoints,
                           Object inTargetFeatures,
                           Object outLineFeatureClass)
Creates the Construct Sight Lines 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:
inObserverPoints - the observer point(s).
inTargetFeatures - the target features (points, multipoints, lines, polygons).
outLineFeatureClass - the output feature class containing the 2D/3D sight lines.
Method Detail

getInObserverPoints

public Object getInObserverPoints()
Returns the Observer Points parameter of this tool . This parameter is the observer point(s). This is a required parameter.

Returns:
the Observer Points

setInObserverPoints

public void setInObserverPoints(Object inObserverPoints)
Sets the Observer Points parameter of this tool . This parameter is the observer point(s). This is a required parameter.

Parameters:
inObserverPoints - the observer point(s).

getInTargetFeatures

public Object getInTargetFeatures()
Returns the Target Features parameter of this tool . This parameter is the target features (points, multipoints, lines, polygons). This is a required parameter.

Returns:
the Target Features

setInTargetFeatures

public void setInTargetFeatures(Object inTargetFeatures)
Sets the Target Features parameter of this tool . This parameter is the target features (points, multipoints, lines, polygons). This is a required parameter.

Parameters:
inTargetFeatures - the target features (points, multipoints, lines, polygons).

getOutLineFeatureClass

public Object getOutLineFeatureClass()
Returns the Output parameter of this tool . This parameter is the output feature class containing the 2D/3D sight lines. This is a required parameter.

Returns:
the Output

setOutLineFeatureClass

public void setOutLineFeatureClass(Object outLineFeatureClass)
Sets the Output parameter of this tool . This parameter is the output feature class containing the 2D/3D sight lines. This is a required parameter.

Parameters:
outLineFeatureClass - the output feature class containing the 2D/3D sight lines.

getObserverHeightField

public String getObserverHeightField()
Returns the Observer Height Field parameter of this tool . This parameter is the height field for the observer. a default Observer Height Field field is selected by searching from the list below in that order. If no suitable height field exists a field value of will be used. This is an optional parameter.

Returns:
the Observer Height Field

setObserverHeightField

public void setObserverHeightField(String observerHeightField)
Sets the Observer Height Field parameter of this tool . This parameter is the height field for the observer. a default Observer Height Field field is selected by searching from the list below in that order. If no suitable height field exists a field value of will be used. This is an optional parameter.

Parameters:
observerHeightField - the height field for the observer. a default Observer Height Field field is selected by searching from the list below in that order. If no suitable height field exists a field value of will be used.

getTargetHeightField

public String getTargetHeightField()
Returns the Target Height Field parameter of this tool . This parameter is the height field for the target. a default Target Height Field field is selected by searching from the list below in that order. If no suitable height field exists a field value of will be used. This is an optional parameter.

Returns:
the Target Height Field

setTargetHeightField

public void setTargetHeightField(String targetHeightField)
Sets the Target Height Field parameter of this tool . This parameter is the height field for the target. a default Target Height Field field is selected by searching from the list below in that order. If no suitable height field exists a field value of will be used. This is an optional parameter.

Parameters:
targetHeightField - the height field for the target. a default Target Height Field field is selected by searching from the list below in that order. If no suitable height field exists a field value of will be used.

getJoinField

public String getJoinField()
Returns the Join Field parameter of this tool . This parameter is the join field is used to match observers to specific targets. This is an optional parameter.

Returns:
the Join Field

setJoinField

public void setJoinField(String joinField)
Sets the Join Field parameter of this tool . This parameter is the join field is used to match observers to specific targets. This is an optional parameter.

Parameters:
joinField - the join field is used to match observers to specific targets.

getSampleDistance

public double getSampleDistance()
Returns the Sampling Distance parameter of this tool . This parameter is the distance between samples when the target is either a line or polygon feature class. The Sampling Distance units should be given in x,y units of output feature class. This is an optional parameter.

Returns:
the Sampling Distance

setSampleDistance

public void setSampleDistance(double sampleDistance)
Sets the Sampling Distance parameter of this tool . This parameter is the distance between samples when the target is either a line or polygon feature class. The Sampling Distance units should be given in x,y units of output feature class. This is an optional parameter.

Parameters:
sampleDistance - the distance between samples when the target is either a line or polygon feature class. The Sampling Distance units should be given in x,y units of output feature class.

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