com.esri.arcgis.geoprocessing.tools.cartographytools
Class ThinRoadNetwork

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.ThinRoadNetwork

All Implemented Interfaces:

GPTool

public class ThinRoadNetwork
extends AbstractGPTool

Generates a simplified road network that retains connectivity and general character to display at a smaller scale. The Thin Road Network tool is contained in the Cartography Tools tool box.

Usage tips:

• The Invisibility Field must be present and named the same for all input feature classes. Features that should remain visible are assigned a value of 0; those that should be removed from the display are assigned a value of 1. Use a layer definition query or a selection to display the resulting simplified collection (i.e., invisibility <> 1). You can use multiple invisibility fields to store different results—corresponding to different output scales—on the same feature class.
• The Hierarchy Field identifies the relative importance of features to help establish which features are significant. Hierarchy value 1 indicates the most important features with importance decreasing as hierarchy value increases. For optimal results, use no more than five levels of hierarchy. Input roads with Hierarchy = 0 are considered "locked" and will remain visible, along with adjacent roads necessary for connectivity. The hierarchy field must be present and named the same for all input feature classes.The hierarchy is typically derived from a field that specifies road classification and corresponds to the way that roads are symbolized. It is not related to the concept of hierarchy used in network analysis.
• The Minimum Distance parameter defines a sense of the resolution or granularity of the resulting simplified road collection. It should correspond to a length that is visually significant to include at the final scale. The results of this tool are a balanced compromise between the requirements posed by hierarchy, visibility locking, resolution, and the morphology and connectivity of the road geometry. Therefore, the minimum distance value cannot necessarily be measured directly in the resulting feature set.
• The integrity of the results of this tool relies on the topological integrity of the inputs. Proper connections must exist at intersections to faithfully represent the connectivity of the road network. See for more information about data requirements and other helpful tips.
• If the inputs include a feature layer pointing to a representation, any geometry overrides associated with that representation will be used as the input geometry to determine the morphology and connectivity of the road collection. Similarly, representation visibility overrides will be honored, ensuring that invisible representations are not included in the resulting road collection, and that adjacent roads are handled accordingly to maintain connectivity.

Field Summary

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

vals

Constructor Summary

ThinRoadNetwork()
Creates the Thin Road Network tool with defaults.

ThinRoadNetwork(Object inFeatures, Object minimumLength, String invisibilityField, String hierarchyField)
Creates the Thin Road Network tool with the required parameters.

Method Summary

String	getHierarchyField() Returns the Hierarchy Field parameter of this tool .
Object	getInFeatures() Returns the Input Road Features parameter of this tool .
String	getInvisibilityField() Returns the Invisibility Field parameter of this tool .
Object	getMinimumLength() Returns the Minimum Length parameter of this tool .
Object	getOutFeatures() Returns the Output Features 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	setHierarchyField(String hierarchyField) Sets the Hierarchy Field parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Road Features parameter of this tool .
void	setInvisibilityField(String invisibilityField) Sets the Invisibility Field parameter of this tool .
void	setMinimumLength(Object minimumLength) Sets the Minimum Length 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

ThinRoadNetwork

public ThinRoadNetwork()

Creates the Thin Road Network tool with defaults.

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

ThinRoadNetwork

public ThinRoadNetwork(Object inFeatures,
                       Object minimumLength,
                       String invisibilityField,
                       String hierarchyField)

Creates the Thin Road Network 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:

inFeatures - the input linear roads that should be thinned to create a simplified collection for display at smaller scales.

minimumLength - an indication of the shortest road segment that is sensible to display at the output scale. This controls the resolution, or density, of the resulting road collection. If the units are in point, mm, cm, or inches the value is considered in page units and the reference scale is taken into account.

invisibilityField - the field that stores the results of the tool. Features that participate in the resulting simplified road collection have a value of 0 (zero). Those that are extraneous have a value of 1. A layer definition query can be used to display the resulting road collection. This field must be present and named the same for each input feature class.

hierarchyField - the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 forces the feature to remain visible in the output collection. This field must be present and named the same for each input feature class.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Road Features parameter of this tool . This parameter is the input linear roads that should be thinned to create a simplified collection for display at smaller scales. This is a required parameter.

Returns:

the Input Road Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Road Features parameter of this tool . This parameter is the input linear roads that should be thinned to create a simplified collection for display at smaller scales. This is a required parameter.

Parameters:

inFeatures - the input linear roads that should be thinned to create a simplified collection for display at smaller scales.

getMinimumLength

public Object getMinimumLength()

Returns the Minimum Length parameter of this tool . This parameter is an indication of the shortest road segment that is sensible to display at the output scale. This controls the resolution, or density, of the resulting road collection. If the units are in point, mm, cm, or inches the value is considered in page units and the reference scale is taken into account. This is a required parameter.

Returns:

the Minimum Length

setMinimumLength

public void setMinimumLength(Object minimumLength)

Sets the Minimum Length parameter of this tool . This parameter is an indication of the shortest road segment that is sensible to display at the output scale. This controls the resolution, or density, of the resulting road collection. If the units are in point, mm, cm, or inches the value is considered in page units and the reference scale is taken into account. This is a required parameter.

Parameters:

minimumLength - an indication of the shortest road segment that is sensible to display at the output scale. This controls the resolution, or density, of the resulting road collection. If the units are in point, mm, cm, or inches the value is considered in page units and the reference scale is taken into account.

getInvisibilityField

public String getInvisibilityField()

Returns the Invisibility Field parameter of this tool . This parameter is the field that stores the results of the tool. Features that participate in the resulting simplified road collection have a value of 0 (zero). Those that are extraneous have a value of 1. A layer definition query can be used to display the resulting road collection. This field must be present and named the same for each input feature class. This is a required parameter.

Returns:

the Invisibility Field

setInvisibilityField

public void setInvisibilityField(String invisibilityField)

Sets the Invisibility Field parameter of this tool . This parameter is the field that stores the results of the tool. Features that participate in the resulting simplified road collection have a value of 0 (zero). Those that are extraneous have a value of 1. A layer definition query can be used to display the resulting road collection. This field must be present and named the same for each input feature class. This is a required parameter.

Parameters:

invisibilityField - the field that stores the results of the tool. Features that participate in the resulting simplified road collection have a value of 0 (zero). Those that are extraneous have a value of 1. A layer definition query can be used to display the resulting road collection. This field must be present and named the same for each input feature class.

getHierarchyField

public String getHierarchyField()

Returns the Hierarchy Field parameter of this tool . This parameter is the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 forces the feature to remain visible in the output collection. This field must be present and named the same for each input feature class. This is a required parameter.

Returns:

the Hierarchy Field

setHierarchyField

public void setHierarchyField(String hierarchyField)

Sets the Hierarchy Field parameter of this tool . This parameter is the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 forces the feature to remain visible in the output collection. This field must be present and named the same for each input feature class. This is a required parameter.

Parameters:

hierarchyField - the field that contains hierarchical ranking of feature importance, where 1 is very important and larger integers reflect decreasing importance. A value of 0 forces the feature to remain visible in the output collection. This field must be present and named the same for each input feature class.

getOutFeatures

public Object getOutFeatures()

Returns the Output Features parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output 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