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

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

All Implemented Interfaces:

GPTool

public class AlignMarkerToStrokeOrFill

extends AbstractGPTool

Align the representation marker symbols of a point feature class to the nearest stroke or fill representation symbols in a line or polygon feature class within a specified search distance. The Align Marker To Stroke Or Fill tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• The tool works on the geometry of the source features, not the representation symbology. So, between a marker and a stroke, for instance, from the centerline of the stroke to the point location of the marker is the search distance.
• Representation markers with the ground locations beyond the search distance are not affected.
• The rotation of markers may create conflicts with nearby symbols. The result needs to be examined or the Detect Graphic Conflict tool can be used to see where the conflicts are.
• The angle property of representation marker symbol layer will be overridden.
• The following environment settings affect this tool: referenceScale; cartographicCoordinateSystem;

Field Summary

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

vals

Constructor Summary

AlignMarkerToStrokeOrFill()
Creates the Align Marker To Stroke Or Fill tool with defaults.

AlignMarkerToStrokeOrFill(java.lang.Object inPointFeatures, java.lang.Object inLineOrPolygonFeatures, java.lang.Object searchDistance)
Creates the Align Marker To Stroke Or Fill tool with the required parameters.

Method Summary

java.lang.Object	getInLineOrPolygonFeatures() Returns the Input Features With Stroke Or Fill Representations parameter of this tool .
java.lang.Object	getInPointFeatures() Returns the Input Features With Marker Representations parameter of this tool .
java.lang.String	getMarkerOrientation() Returns the Marker Orientation parameter of this tool .
java.lang.Object	getOutRepresentations() Returns the Output Representations parameter of this tool (Read only).
java.lang.Object	getSearchDistance() Returns the Search Distance parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setInLineOrPolygonFeatures(java.lang.Object inLineOrPolygonFeatures) Sets the Input Features With Stroke Or Fill Representations parameter of this tool .
void	setInPointFeatures(java.lang.Object inPointFeatures) Sets the Input Features With Marker Representations parameter of this tool .
void	setMarkerOrientation(java.lang.String markerOrientation) Sets the Marker Orientation parameter of this tool .
void	setSearchDistance(java.lang.Object searchDistance) Sets the Search Distance 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

AlignMarkerToStrokeOrFill

public AlignMarkerToStrokeOrFill()

Creates the Align Marker To Stroke Or Fill tool with defaults.

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

AlignMarkerToStrokeOrFill

public AlignMarkerToStrokeOrFill(java.lang.Object inPointFeatures,
                                 java.lang.Object inLineOrPolygonFeatures,
                                 java.lang.Object searchDistance)

Creates the Align Marker To Stroke Or Fill 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:

inPointFeatures - Layer, the input point feature layer containing marker representations.

inLineOrPolygonFeatures - Layer, the input line or polygon feature layer containing stroke or fill representations.

searchDistance - Linear unit, the search distance, in page units. A distance must be specified, and it must be greater than zero. Choose a page unit (Points, Milimeters, and so on) for the search distance; the default is Points.

Method Detail

getInPointFeatures

public java.lang.Object getInPointFeatures()

Returns the Input Features With Marker Representations parameter of this tool . This parameter is Layer, the input point feature layer containing marker representations. This is a required parameter.

Returns:

the Input Features With Marker Representations

setInPointFeatures

public void setInPointFeatures(java.lang.Object inPointFeatures)

Sets the Input Features With Marker Representations parameter of this tool . This parameter is Layer, the input point feature layer containing marker representations. This is a required parameter.

Parameters:

inPointFeatures - Layer, the input point feature layer containing marker representations.

getInLineOrPolygonFeatures

public java.lang.Object getInLineOrPolygonFeatures()

Returns the Input Features With Stroke Or Fill Representations parameter of this tool . This parameter is Layer, the input line or polygon feature layer containing stroke or fill representations. This is a required parameter.

Returns:

the Input Features With Stroke Or Fill Representations

setInLineOrPolygonFeatures

public void setInLineOrPolygonFeatures(java.lang.Object inLineOrPolygonFeatures)

Sets the Input Features With Stroke Or Fill Representations parameter of this tool . This parameter is Layer, the input line or polygon feature layer containing stroke or fill representations. This is a required parameter.

Parameters:

inLineOrPolygonFeatures - Layer, the input line or polygon feature layer containing stroke or fill representations.

getSearchDistance

public java.lang.Object getSearchDistance()

Returns the Search Distance parameter of this tool . This parameter is Linear unit, the search distance, in page units. A distance must be specified, and it must be greater than zero. Choose a page unit (Points, Milimeters, and so on) for the search distance; the default is Points. This is a required parameter.

Returns:

the Search Distance

setSearchDistance

public void setSearchDistance(java.lang.Object searchDistance)

Sets the Search Distance parameter of this tool . This parameter is Linear unit, the search distance, in page units. A distance must be specified, and it must be greater than zero. Choose a page unit (Points, Milimeters, and so on) for the search distance; the default is Points. This is a required parameter.

Parameters:

searchDistance - Linear unit, the search distance, in page units. A distance must be specified, and it must be greater than zero. Choose a page unit (Points, Milimeters, and so on) for the search distance; the default is Points.

getMarkerOrientation

public java.lang.String getMarkerOrientation()

Returns the Marker Orientation parameter of this tool . This parameter is String, specifies the representation marker orientation relative to the stroke or fill edge. This is an optional parameter.

Returns:

the Marker Orientation

setMarkerOrientation

public void setMarkerOrientation(java.lang.String markerOrientation)

Sets the Marker Orientation parameter of this tool . This parameter is String, specifies the representation marker orientation relative to the stroke or fill edge. This is an optional parameter.

Parameters:

markerOrientation - String, specifies the representation marker orientation relative to the stroke or fill edge.

• PERPENDICULAR—aligns representation markers perpendicularly to the stroke or fill edge. This is the default.
• PARALLEL—aligns representation markers parallel to the stroke or fill edge.

getOutRepresentations

public java.lang.Object getOutRepresentations()

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

Returns:

the Output Representations

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias