com.esri.arcgis.geodatabase
Class IUtilityNetworkGENProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.INetworkProxy
          extended by com.esri.arcgis.geodatabase.IUtilityNetworkGENProxy
All Implemented Interfaces:
INetwork, IUtilityNetworkGEN, Externalizable, Serializable

public class IUtilityNetworkGENProxy
extends INetworkProxy
implements IUtilityNetworkGEN, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IUtilityNetworkGENProxy()
           
  IUtilityNetworkGENProxy(Object obj)
           
protected IUtilityNetworkGENProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void establishFlowDirection(int[] sourceEIDs, 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 partialEstablishFlowDirection(int[] sourceEIDs, int[] sinkEIDs)
          Sets the flow direction of all reachable edge elements based on the placement of sources and sinks.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setFlowDirection(int edgeEID, int flowDirection)
          Sets the flow direction for the specified edge element.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.geodatabase.INetworkProxy
createForwardStar, createNetBrowser, getEdgeCount, getJunctionCount, getMaxDegree, getMaxTurn, getStatus, getTurnCount
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.geodatabase.INetwork
createForwardStar, createNetBrowser, getEdgeCount, getJunctionCount, getMaxDegree, getMaxTurn, getStatus, getTurnCount
 

Constructor Detail

IUtilityNetworkGENProxy

public IUtilityNetworkGENProxy()

IUtilityNetworkGENProxy

public IUtilityNetworkGENProxy(Object obj)
                        throws IOException
Throws:
IOException

IUtilityNetworkGENProxy

protected IUtilityNetworkGENProxy(Object obj,
                                  String iid)
                           throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class INetworkProxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class INetworkProxy
Throws:
IOException

isValidFlowDirection

public 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.

Specified by:
isValidFlowDirection in interface IUtilityNetworkGEN
Returns:
The pValidFlowDirection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFlowDirection

public 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.

Specified by:
getFlowDirection in interface IUtilityNetworkGEN
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

public 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.

Specified by:
setFlowDirection in interface IUtilityNetworkGEN
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

public void establishFlowDirection(int[] sourceEIDs,
                                   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.

Specified by:
establishFlowDirection in interface IUtilityNetworkGEN
Parameters:
sourceEIDs - The sourceEIDs (in)
sinkEIDs - The sinkEIDs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

partialEstablishFlowDirection

public void partialEstablishFlowDirection(int[] sourceEIDs,
                                          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 IUtilityNetworkGEN::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.

Specified by:
partialEstablishFlowDirection in interface IUtilityNetworkGEN
Parameters:
sourceEIDs - The sourceEIDs (in)
sinkEIDs - The sinkEIDs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class INetworkProxy
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class INetworkProxy
Throws:
IOException
ClassNotFoundException