com.esri.arcgis.geodatabase
Interface IUtilityNetwork2

All Superinterfaces:
INetwork, IUtilityNetwork, Serializable
All Known Implementing Classes:
IUtilityNetwork2Proxy

public interface IUtilityNetwork2
extends IUtilityNetwork, Serializable

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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


Method Summary
 void partialEstablishFlowDirection(int sourceCount, int[] sourceEIDs, int sinkCount, int[] sinkEIDs)
          Sets the flow direction of all reachable edge elements based on the placement of sources and sinks.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IUtilityNetwork
establishFlowDirection, getFlowDirection, isValidFlowDirection, setFlowDirection
 
Methods inherited from interface com.esri.arcgis.geodatabase.INetwork
createForwardStar, createNetBrowser, getEdgeCount, getJunctionCount, getMaxDegree, getMaxTurn, getStatus, getTurnCount
 

Method Detail

partialEstablishFlowDirection

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

Remarks

PartialEstablishFlowDirection will set the flow direction for the 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.

PartialEstablishFlowDirection is very similar to IUtilityNetwork::EstablishFlowDirection. The difference is in those edge elements that cannot be reached from the specified sources and/or sinks. In EstablishFlowDirection, these edges will be set to uninitialized flow. In PartialEstablishFlowDirection, these unreachable edges will retain their original flow direction value.

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::PartialEstablishFlowDirection.

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.