|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.analyst3dtools.LineOfSight
public class LineOfSight
This tool uses an input 2D or 3D polyline feature class along with a raster, triangulated irregular network (TIN), or terrain dataset surface to determine visibility between observer and target points. A multipatch feature class can optionally be supplied to participate in the visibility analysis. The Line Of Sight tool is contained in the 3D Analyst Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
LineOfSight()
Creates the Line Of Sight tool with defaults. |
|
LineOfSight(Object inSurface,
Object inLineFeatureClass,
Object outLosFeatureClass)
Creates the Line Of Sight tool with the required parameters. |
Method Summary | |
---|---|
Object |
getInFeatures()
Returns the Input Features parameter of this tool . |
Object |
getInLineFeatureClass()
Returns the Input Line Features parameter of this tool . |
Object |
getInSurface()
Returns the Input Surface parameter of this tool . |
Object |
getOutLosFeatureClass()
Returns the Output Feature Class parameter of this tool . |
Object |
getOutObstructionFeatureClass()
Returns the Output Obstruction Point Feature Class parameter of this tool . |
double |
getPyramidLevelResolution()
Returns the Pyramid Level Resolution parameter of this tool . |
double |
getRefractionFactor()
Returns the Refraction Factor 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. |
String |
getUseCurvature()
Returns the Use Curvature parameter of this tool . |
String |
getUseRefraction()
Returns the Use Refraction parameter of this tool . |
void |
setInFeatures(Object inFeatures)
Sets the Input Features parameter of this tool . |
void |
setInLineFeatureClass(Object inLineFeatureClass)
Sets the Input Line Features parameter of this tool . |
void |
setInSurface(Object inSurface)
Sets the Input Surface parameter of this tool . |
void |
setOutLosFeatureClass(Object outLosFeatureClass)
Sets the Output Feature Class parameter of this tool . |
void |
setOutObstructionFeatureClass(Object outObstructionFeatureClass)
Sets the Output Obstruction Point Feature Class parameter of this tool . |
void |
setPyramidLevelResolution(double pyramidLevelResolution)
Sets the Pyramid Level Resolution parameter of this tool . |
void |
setRefractionFactor(double refractionFactor)
Sets the Refraction Factor parameter of this tool . |
void |
setUseCurvature(String useCurvature)
Sets the Use Curvature parameter of this tool . |
void |
setUseRefraction(String useRefraction)
Sets the Use Refraction 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 |
---|
public LineOfSight()
Initializes the array of tool parameters with the default values specified when the tool was created.
public LineOfSight(Object inSurface, Object inLineFeatureClass, Object outLosFeatureClass)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inSurface
- the input raster, TIN, or terrain surface on which calculations are based.inLineFeatureClass
- the input polyline feature class along which visibility is calculated. This can be a 2D or 3D feature class.outLosFeatureClass
- the output line feature class along which visibility has been determined. Two attribute fields are created. VisCode indicates visibility along the line, 1 being visible and 2 not visible. TarIsVis indicates the target visibility, 0 being not visible and 1 being visible.Method Detail |
---|
public Object getInSurface()
public void setInSurface(Object inSurface)
inSurface
- the input raster, TIN, or terrain surface on which calculations are based.public Object getInLineFeatureClass()
public void setInLineFeatureClass(Object inLineFeatureClass)
inLineFeatureClass
- the input polyline feature class along which visibility is calculated. This can be a 2D or 3D feature class.public Object getOutLosFeatureClass()
public void setOutLosFeatureClass(Object outLosFeatureClass)
outLosFeatureClass
- the output line feature class along which visibility has been determined. Two attribute fields are created. VisCode indicates visibility along the line, 1 being visible and 2 not visible. TarIsVis indicates the target visibility, 0 being not visible and 1 being visible.public Object getOutObstructionFeatureClass()
public void setOutObstructionFeatureClass(Object outObstructionFeatureClass)
outObstructionFeatureClass
- the output point feature class indicating the first obstruction point along the line of sight if the target is not visible.public String getUseCurvature()
public void setUseCurvature(String useCurvature)
useCurvature
- indicates whether the earth's curvature should be taken into consideration for the line of sight analysis. For this option to be enabled, the surface needs to have a defined spatial reference in projected coordinates with defined z-units.public String getUseRefraction()
public void setUseRefraction(String useRefraction)
useRefraction
- indicates whether atmospheric refraction should be taken into consideration when generating a line of sight from a functional surface.public double getRefractionFactor()
public void setRefractionFactor(double refractionFactor)
refractionFactor
- provides a value to be used in the refraction factor. The default refraction factor is 0.13.public double getPyramidLevelResolution()
public void setPyramidLevelResolution(double pyramidLevelResolution)
pyramidLevelResolution
- the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution.public Object getInFeatures()
public void setInFeatures(Object inFeatures)
inFeatures
- a feature class of multipatches which may obstruct the line(s) of sight. Default is blank.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |