com.esri.arcgis.networkanalysis
Interface INetElementBarriers

All Superinterfaces:
Serializable
All Known Subinterfaces:
INetElementBarriers2
All Known Implementing Classes:
INetElementBarriers2Proxy, INetElementBarriersProxy

public interface INetElementBarriers
extends 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.

Supported Platforms

Windows, Solaris, Linux

See Also:

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


Method Summary
 int getElementType()
          Type of network element on which the barriers are placed.
 INetwork getNetwork()
          Network on which the barrier set is placed.
 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.
 

Method Detail

setNetworkByRef

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

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

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

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

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

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

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

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

setBarriers

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.

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.