com.esri.arcgis.geodatabase
Interface IUtilityNetwork

All Superinterfaces:
INetwork, Serializable
All Known Subinterfaces:
IUtilityNetwork2
All Known Implementing Classes:
IUtilityNetwork2Proxy, IUtilityNetworkProxy

public interface IUtilityNetwork
extends INetwork, Serializable

Provides access to members that get and set flow direction in a utility network.

Superseded By

IUtilityNetwork2

Remarks

The only elements in a network that can have flow are edge elements. Junction elements do not have flow.

Flow is maintained in the logical network and not the geometric network. Unlike creating flags, which is done on a feature in the geometric network, changing flow direction on individual elements requires that you directly manipulate the logical network.

This operation requires that you make the network editable. You can do this either through an edit session, using the Editor, or you can use the IWorkspaceEdit interface to edit the workspace of the logical network.

When To Use

Use the IUtilityNetwork interface for establishing flow direction for your network. You can also use this interface to check the flow direction for a particular element and change the flow direction on a particular element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
INetworkUpdate, IForwardStar, IGraph, INetworkClass.getNetworkAncillaryRole(), INetworkWorkspace, INetworkClass.getGeometricNetwork(), INetworkClass.getFieldToWeightMapping(int), IUtilityNetwork,

Not all members are callable from Java. Please use IUtilityNetworkGEN instead.


Method Summary
 void establishFlowDirection(int sourceCount, int[] sourceEIDs, int sinkCount, int[] sinkEIDs)
          Sets the flow direction of all edge elements based on the placement of sources and sinks.
 int getFlowDirection(int edgeEID)
          Returns the flow direction of the specified edge element.
 boolean isValidFlowDirection()
          Indicates if the flow direction is valid for this utility network.
 void setFlowDirection(int edgeEID, int flowDirection)
          Sets the flow direction for the specified edge element.
 
Methods inherited from interface com.esri.arcgis.geodatabase.INetwork
createForwardStar, createNetBrowser, getEdgeCount, getJunctionCount, getMaxDegree, getMaxTurn, getStatus, getTurnCount
 

Method Detail

isValidFlowDirection

boolean isValidFlowDirection()
                             throws IOException,
                                    AutomationException
Indicates if the flow direction is valid for this utility network.

Remarks

ValidFlowDirection specifies whether the logical network has flow direction defined on it. Use EstablishFlowDirection on this same interface to set the flow direction.

In this release, ValidFlowDirection is not implemented -- for now, this property always returns False.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The validFlowDirection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlowDirection

int getFlowDirection(int edgeEID)
                     throws IOException,
                            AutomationException
Returns the flow direction of the specified edge element.

Remarks

GetFlowDirection returns the flow direction for the specified edge element. Possible flow directions are (with and against values are in relation to the digitized direction of the element):

esriFDAgainstFlow

esriFDIndeterminate

esriFDUninitialized

esriFDWithFlow

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
edgeEID - The edgeEID (in)
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 edgeEID,
                      int flowDirection)
                      throws IOException,
                             AutomationException
Sets the flow direction for the specified edge element.

Remarks

SetFlowDirection will set the flow direction for the specified edge element. Flow direction can be set to one of these possible values:

esriFDAgainstFlow

esriFDIndeterminate

esriFDUninitialized

esriFDWithFlow

This operation requires that you make the network editable. You can do this either through an edit session, using the Editor, or you can use the IWorkspaceEdit interface to edit the workspace of the logical network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

establishFlowDirection

void establishFlowDirection(int sourceCount,
                            int[] sourceEIDs,
                            int sinkCount,
                            int[] sinkEIDs)
                            throws IOException,
                                   AutomationException
Sets the flow direction of all edge elements based on the placement of sources and sinks.

Remarks

EstablishFlowDirection will set the flow direction for the entire network based on the input sources (starting points) and/or sinks (collection points). In the majority of cases your network will have either sources or sinks, but not both. Having both sources and sinks in your network will often lead to indeterminate flow on the edge elements. Any edge elements that cannot be reached from the specified sources and/or sinks will have uninitialized flow.

The flow direction established on the edges will be based on these possible values:

esriFDAgainstFlow
esriFDIndeterminate
esriFDUninitialized
esriFDWithFlow

This operation requires that you make the network editable. You can do this either through an edit session, using the Editor, or you can use the IWorkspaceEdit interface to edit the workspace of the logical network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

This method is not callable from Java. Please use IUtilityNetworkGEN::EstablishFlowDirection.

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