com.esri.arcgis.networkanalysis
Interface INetElementBarriersGEN

All Superinterfaces:

Serializable

All Known Implementing Classes:

NetElementBarriers

public interface INetElementBarriersGEN
extends Serializable

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

Remarks

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

When To Use

Use the INetElementBarriersGEN 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.

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[] userIDs) Specifies a set of network features to use as barriers.
void	setBarriersByEID(int[] eIDs) Specifies a set of network element IDs 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.

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.

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.

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[] 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.

Parameters:

userClassID - The userClassID (in)

userIDs - The userIDs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBarriersByEID

void setBarriersByEID(int[] eIDs)
                      throws IOException,
                             AutomationException

Specifies a set of network element IDs to use as barriers.

Remarks

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

If there are values in the array that do not correspond to a valid EID in the specified Network, then the NetElementBarriers object simply ignores these values.

Product Availability

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

Parameters:

eIDs - The eIDs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.