com.esri.arcgis.schematic
Interface ISchematicAlgoRotateNodesAlongLinks

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicAlgoRotateNodesAlongLinksProxy, SchematicAlgoRotateNodesAlongLinks

public interface ISchematicAlgoRotateNodesAlongLinks
extends 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

void	execute(INgDiagram pDiag) Executes the Rotate Nodes Along Links schematic algorithm in the specified graphic diagram.
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.
void	initialize(INgProject ngProject) Initializes the Rotate Nodes Along Links schematic algorithm for the specified graphic project.
void	interactiveUpdate(String diagramTypeName, boolean on) Enables the automatical execution of the Rotate Nodes Along Links algorithm each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.
void	interactiveUpdateByDiagram(String diagramTypeName, String diagramName, boolean on) Enables the automatical execution of the Rotate Nodes Along Links algorithm each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.
boolean	isFlowDirected() Indicates if the rotation angle for each symbol's node must be computed regarding to the flow orientation defined for the links.
boolean	isInteractiveUpdate(String diagramTypeName) Indicates if the Rotate Nodes Along Links algorithm must be automatically applied each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.
boolean	isInteractiveUpdateByDiagram(String diagramTypeName, String diagramName) Indicates if the Rotate Nodes Along Links algorithm must be automatically applied each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.
boolean	isInteractiveUpdateStatus() Indicates if the Automatically applied option is currently checked in the Geo - Rotate Nodes Along Links algorithm properties tab.
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	setInteractiveUpdateStatus(boolean bStatus) Indicates if the Automatically applied option is currently checked in the Geo - Rotate Nodes Along Links algorithm properties tab.
void	setOffset(double pOffset) Rotation angle in degrees that is combined with the computed rotation angle to rotate the symbols nodes.

Method Detail

initialize

void initialize(INgProject ngProject)
                throws IOException,
                       AutomationException

Initializes the Rotate Nodes Along Links schematic algorithm for the specified graphic project.

Product Availability

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

Parameters:

ngProject - A reference to a com.esri.arcgis.schematic.INgProject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

void execute(INgDiagram pDiag)
             throws IOException,
                    AutomationException

Executes the Rotate Nodes Along Links schematic algorithm in the specified graphic diagram.

Product Availability

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

Parameters:

pDiag - A reference to a com.esri.arcgis.schematic.INgDiagram (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interactiveUpdate

void interactiveUpdate(String diagramTypeName,
                       boolean on)
                       throws IOException,
                              AutomationException

Enables the automatical execution of the Rotate Nodes Along Links algorithm each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in, optional, pass if not required)

on - The on (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRotateNodesAlongLinks.isInteractiveUpdate(String)

interactiveUpdateByDiagram

void interactiveUpdateByDiagram(String diagramTypeName,
                                String diagramName,
                                boolean on)
                                throws IOException,
                                       AutomationException

Enables the automatical execution of the Rotate Nodes Along Links algorithm each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in)

diagramName - The diagramName (in)

on - The on (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRotateNodesAlongLinks.isInteractiveUpdateByDiagram(String, String)

isInteractiveUpdate

boolean isInteractiveUpdate(String diagramTypeName)
                            throws IOException,
                                   AutomationException

Indicates if the Rotate Nodes Along Links algorithm must be automatically applied each time the graphic elements contained in any diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in)

Returns:

The on

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRotateNodesAlongLinks.interactiveUpdate(String, boolean)

isInteractiveUpdateByDiagram

boolean isInteractiveUpdateByDiagram(String diagramTypeName,
                                     String diagramName)
                                     throws IOException,
                                            AutomationException

Indicates if the Rotate Nodes Along Links algorithm must be automatically applied each time the graphic elements contained in the specified diagram implemented by the specified graphic diagram type are moved.

Product Availability

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

Parameters:

diagramTypeName - The diagramTypeName (in)

diagramName - The diagramName (in)

Returns:

The on

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRotateNodesAlongLinks.interactiveUpdateByDiagram(String, String, boolean)

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.

setInteractiveUpdateStatus

void setInteractiveUpdateStatus(boolean bStatus)
                                throws IOException,
                                       AutomationException

Indicates if the Automatically applied option is currently checked in the Geo - Rotate Nodes Along Links algorithm properties tab.

Product Availability

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

Parameters:

bStatus - The bStatus (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInteractiveUpdateStatus

boolean isInteractiveUpdateStatus()
                                  throws IOException,
                                         AutomationException

Indicates if the Automatically applied option is currently checked in the Geo - Rotate Nodes Along Links algorithm properties tab.

Product Availability

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

Returns:

The bStatus

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicAlgoRotateNodesAlongLinks.isInteractiveUpdate(String)

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)