|
|||||||||
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.cartographytools.CreateOverpass
public class CreateOverpass
Allows intersecting lines to be displayed as overpassing one another by creating bridge parapets and masks to cover the underlying road segment. The Create Overpass tool is contained in the Cartography Tools tool box.
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 |
---|
public CreateOverpass()
Initializes the array of tool parameters with the default values specified when the tool was created.
public CreateOverpass(Object inAboveFeatures, Object inBelowFeatures, Object marginAlong, Object marginAcross, Object outOverpassFeatureClass, Object outMaskRelationshipClass)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inAboveFeatures
- the input line feature layer containing stroke representations that intersect—and will be symbolized as passing above—stroke representations in the Input Below Features.inBelowFeatures
- the input line feature layer containing stroke representations that intersect—and will be symbolized as passing below—stroke representations in the Input Above Features. These features will be masked by the polygons created in the Output Overpass feature class.marginAlong
- sets the length of the mask polygons along the Input Above Features by specifying 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, millimeters, and so on) for the margin; the default is points.marginAcross
- sets the width of the mask polygons across the Input Above Features by specifying 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, millimeters, and so on) for the margin; the default is points.outOverpassFeatureClass
- the output feature class that will be created to store polygons to mask the Input Below features.outMaskRelationshipClass
- 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 |
---|
public Object getInAboveFeatures()
public void setInAboveFeatures(Object inAboveFeatures)
inAboveFeatures
- the input line feature layer containing stroke representations that intersect—and will be symbolized as passing above—stroke representations in the Input Below Features.public Object getInBelowFeatures()
public void setInBelowFeatures(Object inBelowFeatures)
inBelowFeatures
- the input line feature layer containing stroke representations that intersect—and will be symbolized as passing below—stroke representations in the Input Above Features. These features will be masked by the polygons created in the Output Overpass feature class.public Object getMarginAlong()
public void setMarginAlong(Object marginAlong)
marginAlong
- sets the length of the mask polygons along the Input Above Features by specifying 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, millimeters, and so on) for the margin; the default is points.public Object getMarginAcross()
public void setMarginAcross(Object marginAcross)
marginAcross
- sets the width of the mask polygons across the Input Above Features by specifying 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, millimeters, and so on) for the margin; the default is points.public Object getOutOverpassFeatureClass()
public void setOutOverpassFeatureClass(Object outOverpassFeatureClass)
outOverpassFeatureClass
- the output feature class that will be created to store polygons to mask the Input Below features.public Object getOutMaskRelationshipClass()
public void setOutMaskRelationshipClass(Object outMaskRelationshipClass)
outMaskRelationshipClass
- the output relationship class that will be created to store links between Overpass mask polygons and the stroke representations of the Input Below Features.public Object getWhereClause()
public void setWhereClause(Object whereClause)
whereClause
- a SQL expression used to select a subset of features in the Input
Above Features with Representations parameter. the syntax for the expression differs slightly depending on the data source. For example, if you're querying file or ArcSDE geodatabases, shapefiles, or coverages, enclose field names in double quotes: "MY_FIELD" if you're querying personal geodatabases, enclose fields in square brackets: [MY_FIELD] in the Python Window enclose the {where_clause} in parentheses to ensure the spaces (which are delimiters between parameters) are correctly interpreted. for more information on SQL syntax and how it differs between data sources, see SQL Reference.public Object getOutDecorationFeatureClass()
public void setOutDecorationFeatureClass(Object outDecorationFeatureClass)
outDecorationFeatureClass
- the output line feature class that will be created to store parapet features.public String getWingType()
public void setWingType(String wingType)
wingType
- specifies the wing style of the parapet features.public Object getWingTickLength()
public void setWingTickLength(Object wingTickLength)
wingTickLength
- 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, Millimeters, and so on) for the length; the default is Points. This parameter does not apply to the Wing Type - NONE.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 |