com.esri.arcgis.schematic
Interface ISchematicAlgoRotateNodesAlongLinks

All Superinterfaces:

ISchematicAlgorithm, Serializable

All Known Implementing Classes:

SchematicAlgoRotateNodesAlongLinks

public interface ISchematicAlgoRotateNodesAlongLinks
extends ISchematicAlgorithm, Serializable

Provides access to members that control the Rotate Nodes Along Links schematic algorithm.

Description

The Rotate Nodes Along Links algorithm changes the rotation of symbols used to represent the schematic nodes according to the directions of their connected links. The nodes are rotated according to a given angle. The flow direction defined for the schematic links can be taken into account but isn't necessary.

Remarks

The rotation angle computed during algorithm execution is stored in the ROTATION field of each schematic feature class that implements the nodes in the schematic diagram. This ROTATION field must be turned on to symbolize the schematic nodes so they automatically rotate according to the computed angle values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getFlowUserDataName() Name of the userdata that determines the flow direction for each link.
double	getOffset() Rotation angle in degrees that is combined with the computed rotation angle to rotate the symbols nodes.
boolean	isFlowDirected() Indicates if the rotation angle for each symbol's node must be computed regarding to the flow orientation defined for the links.
void	setFlowDirected(boolean pOriented) Indicates if the rotation angle for each symbol's node must be computed regarding to the flow orientation defined for the links.
void	setFlowUserDataName(String flowUserDataName) Name of the userdata that determines the flow direction for each link.
void	setOffset(double pOffset) Rotation angle in degrees that is combined with the computed rotation angle to rotate the symbols nodes.

Methods inherited from interface com.esri.arcgis.schematic.ISchematicAlgorithm

execute, getAlgorithmCLSID, getLabel, getPropertySet, getSchematicDiagramClassName, isAvailable, isEnabled, isOverridable, isUseEndNode, isUseRootNode, setAvailable, setLabel, setOverridable, setPropertySet, setSchematicDiagramClassNameByRef

Method Detail

setFlowDirected

void setFlowDirected(boolean pOriented)
                     throws IOException,
                            AutomationException

Indicates if the rotation angle for each symbol's node must be computed regarding to the flow orientation defined for the links.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pOriented - The pOriented (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFlowDirected

boolean isFlowDirected()
                       throws IOException,
                              AutomationException

Indicates if the rotation angle for each symbol's node must be computed regarding to the flow orientation defined for the links.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pOriented

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double pOffset)
               throws IOException,
                      AutomationException

Rotation angle in degrees that is combined with the computed rotation angle to rotate the symbols nodes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pOffset - The pOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException

Rotation angle in degrees that is combined with the computed rotation angle to rotate the symbols nodes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlowUserDataName

void setFlowUserDataName(String flowUserDataName)
                         throws IOException,
                                AutomationException

Name of the userdata that determines the flow direction for each link.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

flowUserDataName - The flowUserDataName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlowUserDataName

String getFlowUserDataName()
                           throws IOException,
                                  AutomationException

Name of the userdata that determines the flow direction for each link.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The flowUserDataName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.