com.esri.arcgis.networkanalysis
Class INetElementBarriersProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.networkanalysis.INetElementBarriersProxy
All Implemented Interfaces:
INetElementBarriers, Externalizable, Serializable
Direct Known Subclasses:
INetElementBarriers2Proxy

public class INetElementBarriersProxy
extends com.esri.arcgis.interop.Dispatch
implements INetElementBarriers, Serializable

Provides access to members that specify a set of barriers for the TraceFlowSolver object.

Superseded By

INetElementBarriers2

Remarks

Sets of junction barriers and edge barriers should be created seperately.

When To Use

Use the INetElementBarriers interface to create a set of barriers to pass to the TraceFlowSolver object.

Barriers are stopping points affecting a trace. For example, a downed powerline can be a barrier that affects a trace. Barriers do not affect the flow through a network. If you want to change the flow through a stand-alone logical network you can disable individual elements using the INetAttributesEdit::SetDisabledState method. For geometric networks, set the INetworkFeature::Enabled property to False.

Product Availability

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

See Also:

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

, Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  INetElementBarriersProxy()
           
  INetElementBarriersProxy(Object obj)
           
protected INetElementBarriersProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int getElementType()
          Type of network element on which the barriers are placed.
 INetwork getNetwork()
          Network on which the barrier set is placed.
 void removeListener(String iidStr, Object theListener)
           
 void setBarriers(int userClassID, int count, int[] userIDs)
          Specifies a set of network features to use as barriers.
 void setElementType(int elementType)
          Type of network element on which the barriers are placed.
 void setNetworkByRef(INetwork network)
          Network on which the barrier set is placed.
 
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

INetElementBarriersProxy

public INetElementBarriersProxy()

INetElementBarriersProxy

public INetElementBarriersProxy(Object obj)
                         throws IOException
Throws:
IOException

INetElementBarriersProxy

protected INetElementBarriersProxy(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 com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

setNetworkByRef

public void setNetworkByRef(INetwork network)
                     throws IOException,
                            AutomationException
Network on which the barrier set is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setNetworkByRef in interface INetElementBarriers
Parameters:
network - A reference to a com.esri.arcgis.geodatabase.INetwork (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNetwork

public INetwork getNetwork()
                    throws IOException,
                           AutomationException
Network on which the barrier set is placed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNetwork in interface INetElementBarriers
Returns:
A reference to a com.esri.arcgis.geodatabase.INetwork
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElementType

public void setElementType(int elementType)
                    throws IOException,
                           AutomationException
Type of network element on which the barriers are placed.

Remarks

Barriers can be placed on either edge or junction elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setElementType in interface INetElementBarriers
Parameters:
elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementType

public int getElementType()
                   throws IOException,
                          AutomationException
Type of network element on which the barriers are placed.

Remarks

Barriers can be placed on either edge or junction elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getElementType in interface INetElementBarriers
Returns:
A com.esri.arcgis.geodatabase.esriElementType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBarriers

public void setBarriers(int userClassID,
                        int count,
                        int[] userIDs)
                 throws IOException,
                        AutomationException
Specifies a set of network features to use as barriers.

Remarks

The Network and ElementType properties must be set before calling SetBarriers.

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 INetElementBarriersGEN::SetBarriers.

Specified by:
setBarriers in interface INetElementBarriers
Parameters:
userClassID - The userClassID (in)
count - The count (in)
userIDs - The userIDs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.