com.esri.arcgis.schematic
Interface ISchematicLink

All Superinterfaces:
IObject, IRow, IRowBuffer, Serializable
All Known Implementing Classes:
ISchematicLinkProxy, SchematicLink, SchematicSubLink

public interface ISchematicLink
extends IObject, Serializable

Provides access to members that control the schematic link element.

Product Availability

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

See Also:
ISchematicElement, INgLink

Method Summary
 int getFlowDirection()
          Flow direction of the schematic link.
 ISchematicNode getFromNode()
          Schematic origin node of the link.
 int getFromPort()
          Port number on the schematic origin node used to connect the schematic link.
 ISchematicNode getToNode()
          Schematic extremity node of the link.
 int getToPort()
          Port number on the schematic extremity node used to connect the schematic link.
 void setFlowDirection(int flowDirection)
          Flow direction of the schematic link.
 void setFromNodeByRef(ISchematicNode schematicNode)
          Schematic origin node of the link.
 void setFromPort(int portNumber)
          Port number on the schematic origin node used to connect the schematic link.
 void setToNodeByRef(ISchematicNode schematicNode)
          Schematic extremity node of the link.
 void setToPort(int portNumber)
          Port number on the schematic extremity node used to connect the schematic link.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IObject
esri_getClass
 
Methods inherited from interface com.esri.arcgis.geodatabase.IRow
delete, getOID, getTable, isHasOID, store
 
Methods inherited from interface com.esri.arcgis.geodatabase.IRowBuffer
getFields, getValue, setValue
 

Method Detail

getFromNode

ISchematicNode getFromNode()
                           throws IOException,
                                  AutomationException
Schematic origin node of the link.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicNode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicLink.getToNode()

setFromNodeByRef

void setFromNodeByRef(ISchematicNode schematicNode)
                      throws IOException,
                             AutomationException
Schematic origin node of the link.

Product Availability

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

Parameters:
schematicNode - A reference to a com.esri.arcgis.schematic.ISchematicNode (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToNode

ISchematicNode getToNode()
                         throws IOException,
                                AutomationException
Schematic extremity node of the link.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.schematic.ISchematicNode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicLink.getFromNode()

setToNodeByRef

void setToNodeByRef(ISchematicNode schematicNode)
                    throws IOException,
                           AutomationException
Schematic extremity node of the link.

Product Availability

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

Parameters:
schematicNode - A reference to a com.esri.arcgis.schematic.ISchematicNode (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFromPort

int getFromPort()
                throws IOException,
                       AutomationException
Port number on the schematic origin node used to connect the schematic link.

Product Availability

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

Returns:
The portNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicLink.getToPort()

setFromPort

void setFromPort(int portNumber)
                 throws IOException,
                        AutomationException
Port number on the schematic origin node used to connect the schematic link.

Product Availability

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

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

getToPort

int getToPort()
              throws IOException,
                     AutomationException
Port number on the schematic extremity node used to connect the schematic link.

Product Availability

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

Returns:
The portNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicLink.getFromPort()

setToPort

void setToPort(int portNumber)
               throws IOException,
                      AutomationException
Port number on the schematic extremity node used to connect the schematic link.

Product Availability

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

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

getFlowDirection

int getFlowDirection()
                     throws IOException,
                            AutomationException
Flow direction of the schematic link.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.esriFlowDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFlowDirection

void setFlowDirection(int flowDirection)
                      throws IOException,
                             AutomationException
Flow direction of the schematic link.

Product Availability

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

Parameters:
flowDirection - A com.esri.arcgis.geodatabase.esriFlowDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.