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

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

All Implemented Interfaces:

GPTool

public class SkylineGraph
extends AbstractGPTool

Calculates sky visibility, and optionally generates a table and a polar graph. The table and graph represent the horizontal and vertical angles going from the observer point to each of the vertices on the skyline. The Skyline Graph tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The fields which will always appear in the table are:
• The additional fields are:
• The additional fields are not necessary for generating the graph.
• The arithmetic horizontal angle is equal to 90 minus the azimuth, and the zenith angle is 90 minus the vertical angle. (An arithmetic horizontal angle of 0 is due east, and 90 is due north; a zenith angle of 90 is horizontal, and 0 is straight up.)

Field Summary

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

vals

Constructor Summary

SkylineGraph()
Creates the Skyline Graph tool with defaults.

SkylineGraph(Object inObserverPointFeatures, Object inLineFeatures)
Creates the Skyline Graph tool with the required parameters.

Method Summary

String	getAdditionalFields() Returns the Additional Fields parameter of this tool .
double	getBaseVisibilityAngle() Returns the Base Visibility Angle parameter of this tool .
Object	getInLineFeatures() Returns the Input Line Features parameter of this tool .
Object	getInObserverPointFeatures() Returns the Input Observer Point Features parameter of this tool .
Object	getOutAnglesTable() Returns the Output Angles Table parameter of this tool .
Object	getOutGraph() Returns the Output Graph Name parameter of this tool .
double	getOutVisibilityRatio() Returns the Visibility Ratio parameter of this tool (Read only).
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	setAdditionalFields(String additionalFields) Sets the Additional Fields parameter of this tool .
void	setBaseVisibilityAngle(double baseVisibilityAngle) Sets the Base Visibility Angle parameter of this tool .
void	setInLineFeatures(Object inLineFeatures) Sets the Input Line Features parameter of this tool .
void	setInObserverPointFeatures(Object inObserverPointFeatures) Sets the Input Observer Point Features parameter of this tool .
void	setOutAnglesTable(Object outAnglesTable) Sets the Output Angles Table parameter of this tool .
void	setOutGraph(Object outGraph) Sets the Output Graph Name 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

SkylineGraph

public SkylineGraph()

Creates the Skyline Graph tool with defaults.

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

SkylineGraph

public SkylineGraph(Object inObserverPointFeatures,
                    Object inLineFeatures)

Creates the Skyline Graph 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:

inObserverPointFeatures - the feature class containing the observer point.

inLineFeatures - the line feature class representing the skyline.

Method Detail

getInObserverPointFeatures

public Object getInObserverPointFeatures()

Returns the Input Observer Point Features parameter of this tool . This parameter is the feature class containing the observer point. This is a required parameter.

Returns:

the Input Observer Point Features

setInObserverPointFeatures

public void setInObserverPointFeatures(Object inObserverPointFeatures)

Sets the Input Observer Point Features parameter of this tool . This parameter is the feature class containing the observer point. This is a required parameter.

Parameters:

inObserverPointFeatures - the feature class containing the observer point.

getInLineFeatures

public Object getInLineFeatures()

Returns the Input Line Features parameter of this tool . This parameter is the line feature class representing the skyline. 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 line feature class representing the skyline. This is a required parameter.

Parameters:

inLineFeatures - the line feature class representing the skyline.

getBaseVisibilityAngle

public double getBaseVisibilityAngle()

Returns the Base Visibility Angle parameter of this tool . This parameter is the vertical angle which is used as the baseline for calculating percentage of visible sky; 0 is the horizon, 90 is straight up; -90 is straight down. The default is 0. This is an optional parameter.

Returns:

the Base Visibility Angle

setBaseVisibilityAngle

public void setBaseVisibilityAngle(double baseVisibilityAngle)

Sets the Base Visibility Angle parameter of this tool . This parameter is the vertical angle which is used as the baseline for calculating percentage of visible sky; 0 is the horizon, 90 is straight up; -90 is straight down. The default is 0. This is an optional parameter.

Parameters:

baseVisibilityAngle - the vertical angle which is used as the baseline for calculating percentage of visible sky; 0 is the horizon, 90 is straight up; -90 is straight down. The default is 0.

getAdditionalFields

public String getAdditionalFields()

Returns the Additional Fields parameter of this tool . This parameter is determines whether to output additional fields to the table, rather than just the two angle values. This is an optional parameter.

Returns:

the Additional Fields

setAdditionalFields

public void setAdditionalFields(String additionalFields)

Sets the Additional Fields parameter of this tool . This parameter is determines whether to output additional fields to the table, rather than just the two angle values. This is an optional parameter.

Parameters:

additionalFields - determines whether to output additional fields to the table, rather than just the two angle values.

getOutAnglesTable

public Object getOutAnglesTable()

Returns the Output Angles Table parameter of this tool . This parameter is the table to be created for outputting the angles, and so on. The default is blank, meaning no table. This is an optional parameter.

Returns:

the Output Angles Table

setOutAnglesTable

public void setOutAnglesTable(Object outAnglesTable)

Sets the Output Angles Table parameter of this tool . This parameter is the table to be created for outputting the angles, and so on. The default is blank, meaning no table. This is an optional parameter.

Parameters:

outAnglesTable - the table to be created for outputting the angles, and so on. The default is blank, meaning no table.

getOutGraph

public Object getOutGraph()

Returns the Output Graph Name parameter of this tool . This parameter is the name for the desired graph. A table has to be generated in order for the graph to be generated. The graph will be displayed and can be saved and/or edited. The default is blank, meaning no graph. This is an optional parameter.

Returns:

the Output Graph Name

setOutGraph

public void setOutGraph(Object outGraph)

Sets the Output Graph Name parameter of this tool . This parameter is the name for the desired graph. A table has to be generated in order for the graph to be generated. The graph will be displayed and can be saved and/or edited. The default is blank, meaning no graph. This is an optional parameter.

Parameters:

outGraph - the name for the desired graph. A table has to be generated in order for the graph to be generated. The graph will be displayed and can be saved and/or edited. The default is blank, meaning no graph.

getOutVisibilityRatio

public double getOutVisibilityRatio()

Returns the Visibility Ratio parameter of this tool (Read only). This is an derived parameter.

Returns:

the Visibility Ratio

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