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

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

public class CreateOverpass
extends AbstractGPTool

Generates mask polygons at the intersections of stroke representations to symbolize one set of strokes passing above the other. Optionally, linear parapet features can be generated adjacent to these masks. The Create Overpass tool is contained in the Cartography Tools tool box.

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateOverpass()
          Creates the Create Overpass tool with defaults.
CreateOverpass(Object inAboveFeatures, Object inBelowFeatures, Object marginAlong, Object marginAcross, Object outOverpassFeatureClass, Object outMaskRelationshipClass)
          Creates the Create Overpass tool with the required parameters.
 
Method Summary
 Object getInAboveFeatures()
          Returns the Input Above Features With Representations parameter of this tool .
 Object getInBelowFeatures()
          Returns the Input Below Features With Representations parameter of this tool .
 Object getMarginAcross()
          Returns the Margin Across parameter of this tool .
 Object getMarginAlong()
          Returns the Margin Along parameter of this tool .
 Object getOutDecorationFeatureClass()
          Returns the Output Decoration Feature Class parameter of this tool .
 Object getOutMaskRelationshipClass()
          Returns the Output Mask Relationship Class parameter of this tool .
 Object getOutOverpassFeatureClass()
          Returns the Output Overpass Feature Class 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.
 Object getWhereClause()
          Returns the Expression parameter of this tool .
 Object getWingTickLength()
          Returns the Wing Tick Length parameter of this tool .
 String getWingType()
          Returns the Wing Type parameter of this tool .
 void setInAboveFeatures(Object inAboveFeatures)
          Sets the Input Above Features With Representations parameter of this tool .
 void setInBelowFeatures(Object inBelowFeatures)
          Sets the Input Below Features With Representations parameter of this tool .
 void setMarginAcross(Object marginAcross)
          Sets the Margin Across parameter of this tool .
 void setMarginAlong(Object marginAlong)
          Sets the Margin Along parameter of this tool .
 void setOutDecorationFeatureClass(Object outDecorationFeatureClass)
          Sets the Output Decoration Feature Class parameter of this tool .
 void setOutMaskRelationshipClass(Object outMaskRelationshipClass)
          Sets the Output Mask Relationship Class parameter of this tool .
 void setOutOverpassFeatureClass(Object outOverpassFeatureClass)
          Sets the Output Overpass Feature Class parameter of this tool .
 void setWhereClause(Object whereClause)
          Sets the Expression parameter of this tool .
 void setWingTickLength(Object wingTickLength)
          Sets the Wing Tick Length parameter of this tool .
 void setWingType(String wingType)
          Sets the Wing Type 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

CreateOverpass

public CreateOverpass()
Creates the Create Overpass tool with defaults.

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


CreateOverpass

public CreateOverpass(Object inAboveFeatures,
                      Object inBelowFeatures,
                      Object marginAlong,
                      Object marginAcross,
                      Object outOverpassFeatureClass,
                      Object outMaskRelationshipClass)
Creates the Create Overpass 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:
inAboveFeatures - Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing abovestroke representations in the Input Below Features.
inBelowFeatures - Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing belowstroke representations in the Input Above Features. These features will be masked by the polygons created in the Output Overpass feature class.
marginAlong - Linear unit, sets the length of the mask polygons along the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Along must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points.
marginAcross - Linear unit, sets the width of the mask polygons across the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Across must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points.
outOverpassFeatureClass - Feature Class, the output feature class that will be created to store polygons to mask the Input Below features.
outMaskRelationshipClass - Relationship Class, the output relationship class that will be created to store links between Overpass mask polygons and the stroke representations of the Input Below Features.
Method Detail

getInAboveFeatures

public Object getInAboveFeatures()
Returns the Input Above Features With Representations parameter of this tool . This parameter is Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing abovestroke representations in the Input Below Features. This is a required parameter.

Returns:
the Input Above Features With Representations

setInAboveFeatures

public void setInAboveFeatures(Object inAboveFeatures)
Sets the Input Above Features With Representations parameter of this tool . This parameter is Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing abovestroke representations in the Input Below Features. This is a required parameter.

Parameters:
inAboveFeatures - Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing abovestroke representations in the Input Below Features.

getInBelowFeatures

public Object getInBelowFeatures()
Returns the Input Below Features With Representations parameter of this tool . This parameter is Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing belowstroke representations in the Input Above Features. These features will be masked by the polygons created in the Output Overpass feature class. This is a required parameter.

Returns:
the Input Below Features With Representations

setInBelowFeatures

public void setInBelowFeatures(Object inBelowFeatures)
Sets the Input Below Features With Representations parameter of this tool . This parameter is Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing belowstroke representations in the Input Above Features. These features will be masked by the polygons created in the Output Overpass feature class. This is a required parameter.

Parameters:
inBelowFeatures - Layer, the input line feature layer containing stroke representations that intersectand will be symbolized as passing belowstroke representations in the Input Above Features. These features will be masked by the polygons created in the Output Overpass feature class.

getMarginAlong

public Object getMarginAlong()
Returns the Margin Along parameter of this tool . This parameter is Linear unit, sets the length of the mask polygons along the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Along must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points. This is a required parameter.

Returns:
the Margin Along

setMarginAlong

public void setMarginAlong(Object marginAlong)
Sets the Margin Along parameter of this tool . This parameter is Linear unit, sets the length of the mask polygons along the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Along must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points. This is a required parameter.

Parameters:
marginAlong - Linear unit, sets the length of the mask polygons along the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Along must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points.

getMarginAcross

public Object getMarginAcross()
Returns the Margin Across parameter of this tool . This parameter is Linear unit, sets the width of the mask polygons across the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Across must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points. This is a required parameter.

Returns:
the Margin Across

setMarginAcross

public void setMarginAcross(Object marginAcross)
Sets the Margin Across parameter of this tool . This parameter is Linear unit, sets the width of the mask polygons across the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Across must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points. This is a required parameter.

Parameters:
marginAcross - Linear unit, sets the width of the mask polygons across the Input Above Features by specifiying the distance in page units that the mask should extend beyond the width of the stroke symbol of the Input Below Features. The Margin Across must be specified, and it must be greater than or equal to zero. Choose a page unit (Points, Milimeters, and so on) for the margin; the default is Points.

getOutOverpassFeatureClass

public Object getOutOverpassFeatureClass()
Returns the Output Overpass Feature Class parameter of this tool . This parameter is Feature Class, the output feature class that will be created to store polygons to mask the Input Below features. This is a required parameter.

Returns:
the Output Overpass Feature Class

setOutOverpassFeatureClass

public void setOutOverpassFeatureClass(Object outOverpassFeatureClass)
Sets the Output Overpass Feature Class parameter of this tool . This parameter is Feature Class, the output feature class that will be created to store polygons to mask the Input Below features. This is a required parameter.

Parameters:
outOverpassFeatureClass - Feature Class, the output feature class that will be created to store polygons to mask the Input Below features.

getOutMaskRelationshipClass

public Object getOutMaskRelationshipClass()
Returns the Output Mask Relationship Class parameter of this tool . This parameter is Relationship Class, the output relationship class that will be created to store links between Overpass mask polygons and the stroke representations of the Input Below Features. This is a required parameter.

Returns:
the Output Mask Relationship Class

setOutMaskRelationshipClass

public void setOutMaskRelationshipClass(Object outMaskRelationshipClass)
Sets the Output Mask Relationship Class parameter of this tool . This parameter is Relationship Class, the output relationship class that will be created to store links between Overpass mask polygons and the stroke representations of the Input Below Features. This is a required parameter.

Parameters:
outMaskRelationshipClass - Relationship Class, the output relationship class that will be created to store links between Overpass mask polygons and the stroke representations of the Input Below Features.

getWhereClause

public Object getWhereClause()
Returns the Expression parameter of this tool . This parameter is SQL Expression, for more information on SQL syntax and how it differs between data sources, see This is an optional parameter.

Returns:
the Expression

setWhereClause

public void setWhereClause(Object whereClause)
Sets the Expression parameter of this tool . This parameter is SQL Expression, for more information on SQL syntax and how it differs between data sources, see This is an optional parameter.

Parameters:
whereClause - SQL Expression, for more information on SQL syntax and how it differs between data sources, see

getOutDecorationFeatureClass

public Object getOutDecorationFeatureClass()
Returns the Output Decoration Feature Class parameter of this tool . This parameter is Feature Class, the output line feature class that will be created to store parapet features. This is an optional parameter.

Returns:
the Output Decoration Feature Class

setOutDecorationFeatureClass

public void setOutDecorationFeatureClass(Object outDecorationFeatureClass)
Sets the Output Decoration Feature Class parameter of this tool . This parameter is Feature Class, the output line feature class that will be created to store parapet features. This is an optional parameter.

Parameters:
outDecorationFeatureClass - Feature Class, the output line feature class that will be created to store parapet features.

getWingType

public String getWingType()
Returns the Wing Type parameter of this tool . This parameter is String, specifies the wing style of the parapet features. This is an optional parameter.

Returns:
the Wing Type

setWingType

public void setWingType(String wingType)
Sets the Wing Type parameter of this tool . This parameter is String, specifies the wing style of the parapet features. This is an optional parameter.

Parameters:
wingType - String, specifies the wing style of the parapet features.

getWingTickLength

public Object getWingTickLength()
Returns the Wing Tick Length parameter of this tool . This parameter is Linear unit, sets the length of the parapet wings in page units. The length must be greater than or equal to zero; the default length is 1. Choose a page unit (Points, Milimeters, and so on) for the length; the default is Points. This parameter does not apply to the Wing Type - NONE. This is an optional parameter.

Returns:
the Wing Tick Length

setWingTickLength

public void setWingTickLength(Object wingTickLength)
Sets the Wing Tick Length parameter of this tool . This parameter is Linear unit, sets the length of the parapet wings in page units. The length must be greater than or equal to zero; the default length is 1. Choose a page unit (Points, Milimeters, and so on) for the length; the default is Points. This parameter does not apply to the Wing Type - NONE. This is an optional parameter.

Parameters:
wingTickLength - Linear unit, sets the length of the parapet wings in page units. The length must be greater than or equal to zero; the default length is 1. Choose a page unit (Points, Milimeters, and so on) for the length; the default is Points. This parameter does not apply to the Wing Type - NONE.

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