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 allows rotating the symbols used to represent the nodes according to their incident links’ directions. If a selected set has been defined in the active schematic diagram, the algorithm only applies to the selected schematic elements.

Product Availability

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

See Also:
ISchematicAlgoRotateTree

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.
See Also:
ISchematicAlgoRotateNodesAlongLinks.setFlowUserDataName(String)

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.
See Also:
ISchematicAlgoRotateNodesAlongLinks.setFlowDirected(boolean)