com.esri.arcgis.schematic
Interface INgNodeOnLink

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgNodeOnLinkProxy, NgNodeOnLink

public interface INgNodeOnLink
extends Serializable

Provides access to members that control the graphic node-on-link.

Description

A node on link is a node positioned on a link path route. Its location on the link is either absolute or relative. Nodes on links are completely dependent on the link they are related to. Selecting and moving a link automatically selects and moves its nodes on links. The destruction of the link causes the automatic destruction of its nodes on links. Links that connect nodes on links are sublinks. Like nodes, nodes on links exist only in run time; the common properties of a node on link are stored and defined by its related node-on-link type.

Defining nodes on links and sublinks for your links is often useful when you have to graphically display a line that is composed by several different parts. For example, in the electrical world, there are electrical lines that combine an overhead part and an underground part along their path route. In this case, it could be useful to graphically distinguish the overhead part from the underground one using sublinks and nodes on links.

Product Availability

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

See Also:
INgElement, INgNode, ISchematicNodeOnLink, INgSubLink

Method Summary
 double getInitialPosition()
          Initial position of the node-on-link related to its reference link.
 int getPositioningMode()
          Positioning mode of the node-on-link.
 double getPositionOnLink()
          Current position of the node-on-link related to its reference link.
 INgLink getReferenceLink()
          The link the 'node-on-link' node-on-link is related to.
 void setInitialPosition(double pVal)
          Initial position of the node-on-link related to its reference link.
 void setPositionOnLink(double pVal)
          Current position of the node-on-link related to its reference link.
 

Method Detail

getReferenceLink

INgLink getReferenceLink()
                         throws IOException,
                                AutomationException
The link the 'node-on-link' node-on-link is related to.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.INgLink
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPositioningMode

int getPositioningMode()
                       throws IOException,
                              AutomationException
Positioning mode of the node-on-link.

Product Availability

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

Returns:
A com.esri.arcgis.schematic.esriNgPositionOnLinkMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgNodeOnLink.getPositionOnLink()

getPositionOnLink

double getPositionOnLink()
                         throws IOException,
                                AutomationException
Current position of the node-on-link related to its reference link.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgNodeOnLink.getInitialPosition(), INgNodeOnLink.getPositioningMode()

setPositionOnLink

void setPositionOnLink(double pVal)
                       throws IOException,
                              AutomationException
Current position of the node-on-link related to its reference link.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInitialPosition

double getInitialPosition()
                          throws IOException,
                                 AutomationException
Initial position of the node-on-link related to its reference link.

Product Availability

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

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
INgNodeOnLink.getPositionOnLink()

setInitialPosition

void setInitialPosition(double pVal)
                        throws IOException,
                               AutomationException
Initial position of the node-on-link related to its reference link.

Product Availability

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

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.