com.esri.arcgis.networkanalysis
Class TraceFlowSolver

java.lang.Object
  com.esri.arcgis.networkanalysis.TraceFlowSolver

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INetSolver, INetSolverWeightsGEN, ITraceFlowSolverGEN, ISupportErrorInfo, Serializable

public class TraceFlowSolver
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetSolverWeightsGEN, ITraceFlowSolverGEN, INetSolver, ISupportErrorInfo

A collection of basic trace flow solvers used to analyze networks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

TraceFlowSolver()
Constructs a TraceFlowSolver using ArcGIS Engine.

TraceFlowSolver(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TraceFlowSolver theTraceFlowSolver = (TraceFlowSolver) obj;

Method Summary

void	disableElementClass(int classID) Sets an element class as disabled within this solver.
boolean	equals(Object o) Compare this object with another
void	findAccumulation(int flowMethod, int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs, Object[] pTotalCost) Finds the total cost of all reachable network elements based on the specified flow method.
void	findCircuits(int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs) Finds all reachable network elements that are parts of closed circuits in the network.
void	findCommonAncestors(int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs) Finds all reachable network elements that are upstream from all the specified origins.
void	findFlowElements(int flowMethod, int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs) Finds all reachable network elements based on the specified flow method.
void	findFlowEndElements(int flowMethod, int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs) Finds all reachable network end elements based on the specified flow method.
void	findFlowUnreachedElements(int flowMethod, int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs) Finds all unreachable network elements based on the flow method.
void	findPath(int flowMethod, int objFn, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs, int count, Object[][] segmentCosts) Finds a path between the specified origins in the network.
void	findSource(int flowMethod, int objFn, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs, int count, Object[][] segmentCosts) Finds a path upstream to a source or downstream to a sink, depending on the specified flow method.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	putEdgeOrigins(IEdgeFlag[] edgeOrigins) Sets the starting edges for this trace solver.
void	putJunctionOrigins(IJunctionFlag[] junctionOrigins) Sets the starting junctions for this trace solver.
void	setElementBarriersByRef(int elementType, INetElementBarriers rhs2) Network element barrier set to be used in this solver.
void	setFilterRanges(int elementType, Object[] fromValues, Object[] toValues) Sets the range of values to be filtered for the specified network element type.
void	setFilterType(int elementType, int weightFilterType, boolean applyNotOperator) Sets the filter type for the specified network element type.
void	setFromToEdgeFilterWeightByRef(INetWeight rhs1) Weight to be used for filtering edge elements traced in the digitized direction.
void	setFromToEdgeWeightByRef(INetWeight rhs1) Weight to be used to determine the cost of passing through edge elements in the digitized direction.
void	setJunctionFilterWeightByRef(INetWeight rhs1) Weight to be used for filtering junction elements.
void	setJunctionWeightByRef(INetWeight rhs1) Weight to be used to determine the cost of passing through junction elements.
void	setSelectionSetBarriersByRef(ISelectionSetBarriers rhs1) Selection set barriers to be used in this solver.
void	setSourceNetworkByRef(INetwork rhs1) Source network to be used in this solver.
void	setToFromEdgeFilterWeightByRef(INetWeight rhs1) Weight to be used for filtering edge elements traced against the digitized direction.
void	setToFromEdgeWeightByRef(INetWeight rhs1) Weight to be used to determine the cost of passing through edge elements against the digitized direction.
void	setTraceIndeterminateFlow(boolean rhs1) Indicates if directional traces include edges with indeterminate or uninitialized flow direction.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TraceFlowSolver

public TraceFlowSolver()
                throws IOException,
                       UnknownHostException

Constructs a TraceFlowSolver using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TraceFlowSolver

public TraceFlowSolver(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TraceFlowSolver theTraceFlowSolver = (TraceFlowSolver) obj;

Construct a TraceFlowSolver using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TraceFlowSolver.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setJunctionWeightByRef

public void setJunctionWeightByRef(INetWeight rhs1)
                            throws IOException,
                                   AutomationException

Weight to be used to determine the cost of passing through junction elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setJunctionWeightByRef in interface INetSolverWeightsGEN

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromToEdgeWeightByRef

public void setFromToEdgeWeightByRef(INetWeight rhs1)
                              throws IOException,
                                     AutomationException

Weight to be used to determine the cost of passing through edge elements in the digitized direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFromToEdgeWeightByRef in interface INetSolverWeightsGEN

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToFromEdgeWeightByRef

public void setToFromEdgeWeightByRef(INetWeight rhs1)
                              throws IOException,
                                     AutomationException

Weight to be used to determine the cost of passing through edge elements against the digitized direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setToFromEdgeWeightByRef in interface INetSolverWeightsGEN

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJunctionFilterWeightByRef

public void setJunctionFilterWeightByRef(INetWeight rhs1)
                                  throws IOException,
                                         AutomationException

Weight to be used for filtering junction elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setJunctionFilterWeightByRef in interface INetSolverWeightsGEN

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromToEdgeFilterWeightByRef

public void setFromToEdgeFilterWeightByRef(INetWeight rhs1)
                                    throws IOException,
                                           AutomationException

Weight to be used for filtering edge elements traced in the digitized direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFromToEdgeFilterWeightByRef in interface INetSolverWeightsGEN

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToFromEdgeFilterWeightByRef

public void setToFromEdgeFilterWeightByRef(INetWeight rhs1)
                                    throws IOException,
                                           AutomationException

Weight to be used for filtering edge elements traced against the digitized direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setToFromEdgeFilterWeightByRef in interface INetSolverWeightsGEN

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterType

public void setFilterType(int elementType,
                          int weightFilterType,
                          boolean applyNotOperator)
                   throws IOException,
                          AutomationException

Sets the filter type for the specified network element type.

Product Availability

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

Specified by:

setFilterType in interface INetSolverWeightsGEN

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

weightFilterType - A com.esri.arcgis.networkanalysis.esriWeightFilterType constant (in)

applyNotOperator - The applyNotOperator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterRanges

public void setFilterRanges(int elementType,
                            Object[] fromValues,
                            Object[] toValues)
                     throws IOException,
                            AutomationException

Sets the range of values to be filtered for the specified network element type.

Product Availability

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

Specified by:

setFilterRanges in interface INetSolverWeightsGEN

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

fromValues - A Variant (in)

toValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTraceIndeterminateFlow

public void setTraceIndeterminateFlow(boolean rhs1)
                               throws IOException,
                                      AutomationException

Indicates if directional traces include edges with indeterminate or uninitialized flow direction.

Remarks

The TraceIndeterminateFlow property affects the trace results of trace solvers whose FlowMethod parameter is esriFMUpstream or esriFMDownstream. If the TraceIndeterminateFlow parameter is set to False, then the trace solver will only trace on edges whose flow is determined, and only in the direction specified in the FlowMethod parameter of the trace solver. If the TraceIndeterminateFlow parameter is set to True, then the trace solver will not only trace on the aforementioned edges, but also on edges with indeterminate or uninitialized flow.

Set the TraceIndetermiateFlow property before calling any of the trace solvers.

Product Availability

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

Specified by:

setTraceIndeterminateFlow in interface ITraceFlowSolverGEN

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putJunctionOrigins

public void putJunctionOrigins(IJunctionFlag[] junctionOrigins)
                        throws IOException,
                               AutomationException

Sets the starting junctions for this trace solver.

Product Availability

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

Specified by:

putJunctionOrigins in interface ITraceFlowSolverGEN

Parameters:

junctionOrigins - A reference to a com.esri.arcgis.networkanalysis.IJunctionFlag array (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putEdgeOrigins

public void putEdgeOrigins(IEdgeFlag[] edgeOrigins)
                    throws IOException,
                           AutomationException

Sets the starting edges for this trace solver.

Product Availability

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

Specified by:

putEdgeOrigins in interface ITraceFlowSolverGEN

Parameters:

edgeOrigins - A reference to a com.esri.arcgis.networkanalysis.IEdgeFlag array (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFlowElements

public void findFlowElements(int flowMethod,
                             int flowElements,
                             IEnumNetEID[] junctionEIDs,
                             IEnumNetEID[] edgeEIDs)
                      throws IOException,
                             AutomationException

Finds all reachable network elements based on the specified flow method.

Remarks

The FlowMethod parameter determines whether the trace solver traces upstream, downstream, or on all connected edges. If you would like to allow or restrict tracing on edges with indeterminate or uninitialized flow, be sure to set the TraceIndeterminateFlow property prior to calling this trace solver.

The flowElements parameter determines whether edge elements, junction elements, or both are returned by the trace solver.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively.

Product Availability

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

Specified by:

findFlowElements in interface ITraceFlowSolverGEN

Parameters:

flowMethod - A com.esri.arcgis.networkanalysis.esriFlowMethod constant (in)

flowElements - A com.esri.arcgis.networkanalysis.esriFlowElements constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFlowEndElements

public void findFlowEndElements(int flowMethod,
                                int flowElements,
                                IEnumNetEID[] junctionEIDs,
                                IEnumNetEID[] edgeEIDs)
                         throws IOException,
                                AutomationException

Finds all reachable network end elements based on the specified flow method.

Remarks

The FindFlowEndElements method returns those network elements stopping the trace. Network elements stopping a trace are those elements past which a trace cannot continue. These include network elements in a disabled element class (specified by INetSolver::DisableElementClass), and network elements that are connected to only one other network element.

The FlowMethod parameter determines whether the trace solver traces upstream, downstream, or on all connected edges. If you would like to allow or restrict tracing on edges with indeterminate or uninitialized flow, be sure to set the TraceIndeterminateFlow property prior to calling this trace solver.

The flowElements parameter determines whether edge elements, junction elements, or both are returned by the trace solver.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively.

Product Availability

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

Specified by:

findFlowEndElements in interface ITraceFlowSolverGEN

Parameters:

flowMethod - A com.esri.arcgis.networkanalysis.esriFlowMethod constant (in)

flowElements - A com.esri.arcgis.networkanalysis.esriFlowElements constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findPath

public void findPath(int flowMethod,
                     int objFn,
                     IEnumNetEID[] junctionEIDs,
                     IEnumNetEID[] edgeEIDs,
                     int count,
                     Object[][] segmentCosts)
              throws IOException,
                     AutomationException

Finds a path between the specified origins in the network.

Remarks

The FlowMethod parameter determines whether the trace solver traces upstream, downstream, or on all connected edges.

The objFn parameter specifies the objective function of the trace solver. Depending on this parameter, the trace solver will either attempt to minimize the total cost of the path, or will attempt to minimize the maximum cost of any single element in the path.

The Count is the number of path segments to be returned by the trace solver. It is equivalent to one less than the number of flags being passed into the trace solver. The Count is also the size of the array passed into the segmentCosts parameter.

The origins you place on the network using PutEdgeOrigins or PutJunctionOrigins must be either all edge origins or all junction origins. You cannot find a path among a mixture of edge and junction origins.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively, and will return the cost of each segment in the segmentCosts array.

The traced element IDs are returned in the order that they were traced.

Product Availability

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

Specified by:

findPath in interface ITraceFlowSolverGEN

Parameters:

flowMethod - A com.esri.arcgis.networkanalysis.esriFlowMethod constant (in)

objFn - A com.esri.arcgis.networkanalysis.esriShortestPathObjFn constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

count - The count (in)

segmentCosts - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findCircuits

public void findCircuits(int flowElements,
                         IEnumNetEID[] junctionEIDs,
                         IEnumNetEID[] edgeEIDs)
                  throws IOException,
                         AutomationException

Finds all reachable network elements that are parts of closed circuits in the network.

Remarks

The flowElements parameter determines whether edge elements, junction elements, or both are returned by the trace solver.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively.

Product Availability

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

Specified by:

findCircuits in interface ITraceFlowSolverGEN

Parameters:

flowElements - A com.esri.arcgis.networkanalysis.esriFlowElements constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findCommonAncestors

public void findCommonAncestors(int flowElements,
                                IEnumNetEID[] junctionEIDs,
                                IEnumNetEID[] edgeEIDs)
                         throws IOException,
                                AutomationException

Finds all reachable network elements that are upstream from all the specified origins.

Remarks

The flowElements parameter determines whether edge elements, junction elements, or both are returned by the trace solver.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively.

If you would like to allow or restrict tracing on edges with indeterminate or uninitialized flow, be sure to set the TraceIndeterminateFlow property prior to calling this trace solver.

Product Availability

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

Specified by:

findCommonAncestors in interface ITraceFlowSolverGEN

Parameters:

flowElements - A com.esri.arcgis.networkanalysis.esriFlowElements constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFlowUnreachedElements

public void findFlowUnreachedElements(int flowMethod,
                                      int flowElements,
                                      IEnumNetEID[] junctionEIDs,
                                      IEnumNetEID[] edgeEIDs)
                               throws IOException,
                                      AutomationException

Finds all unreachable network elements based on the flow method.

Remarks

The FlowMethod parameter determines whether the trace solver traces upstream, downstream, or on all connected edges. If you would like to allow or restrict tracing on edges with indeterminate or uninitialized flow, be sure to set the TraceIndeterminateFlow property prior to calling this trace solver.

The flowElements parameter determines whether edge elements, junction elements, or both are returned by the trace solver.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively.

Product Availability

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

Specified by:

findFlowUnreachedElements in interface ITraceFlowSolverGEN

Parameters:

flowMethod - A com.esri.arcgis.networkanalysis.esriFlowMethod constant (in)

flowElements - A com.esri.arcgis.networkanalysis.esriFlowElements constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findSource

public void findSource(int flowMethod,
                       int objFn,
                       IEnumNetEID[] junctionEIDs,
                       IEnumNetEID[] edgeEIDs,
                       int count,
                       Object[][] segmentCosts)
                throws IOException,
                       AutomationException

Finds a path upstream to a source or downstream to a sink, depending on the specified flow method.

Remarks

The FlowMethod parameter determines whether the trace solver traces upstream, downstream, or on all connected edges. If you would like to allow or restrict tracing on edges with indeterminate or uninitialized flow, be sure to set the TraceIndeterminateFlow property prior to calling this trace solver.

The objFn parameter specifies the objective function of the trace solver. Depending on this parameter, the trace solver will either attempt to minimize the total cost of the paths to the source, or will attempt to minimize the maximum cost of any single element in the paths to the source.

The Count is the number of path segments to be returned by the trace solver. It is equivalent to the number of flags being passed into the trace solver. The Count is also the size of the array passed into the segmentCosts parameter.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively, and will return the cost of each segment in the segmentCosts array.

The traced element IDs are returned in the order that they were traced.

Product Availability

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

Specified by:

findSource in interface ITraceFlowSolverGEN

Parameters:

flowMethod - A com.esri.arcgis.networkanalysis.esriFlowMethod constant (in)

objFn - A com.esri.arcgis.networkanalysis.esriShortestPathObjFn constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

count - The count (in)

segmentCosts - A Variant (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findAccumulation

public void findAccumulation(int flowMethod,
                             int flowElements,
                             IEnumNetEID[] junctionEIDs,
                             IEnumNetEID[] edgeEIDs,
                             Object[] pTotalCost)
                      throws IOException,
                             AutomationException

Finds the total cost of all reachable network elements based on the specified flow method.

Remarks

The FlowMethod parameter determines whether the trace solver traces upstream, downstream, or on all connected edges. If you would like to allow or restrict tracing on edges with indeterminate or uninitialized flow, be sure to set the TraceIndeterminateFlow property prior to calling this trace solver.

The flowElements parameter determines whether edge elements, junction elements, or both are returned by the trace solver.

The trace solver will return the traced junction and edge element IDs in the junctionEIDs and edgeEIDs parameters respectively, and will return the total cost of the traced elements in the pTotalCost parameter.

Product Availability

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

Specified by:

findAccumulation in interface ITraceFlowSolverGEN

Parameters:

flowMethod - A com.esri.arcgis.networkanalysis.esriFlowMethod constant (in)

flowElements - A com.esri.arcgis.networkanalysis.esriFlowElements constant (in)

junctionEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

edgeEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (out: use single element array)

pTotalCost - A Variant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceNetworkByRef

public void setSourceNetworkByRef(INetwork rhs1)
                           throws IOException,
                                  AutomationException

Source network to be used in this solver.

Remarks

The SourceNetwork is the network on which you want to solve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSourceNetworkByRef in interface INetSolver

Parameters:

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

setElementBarriersByRef

public void setElementBarriersByRef(int elementType,
                                    INetElementBarriers rhs2)
                             throws IOException,
                                    AutomationException

Network element barrier set to be used in this solver.

Remarks

Tells the solver what set of barriers you want to use.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setElementBarriersByRef in interface INetSolver

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

rhs2 - A reference to a com.esri.arcgis.networkanalysis.INetElementBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionSetBarriersByRef

public void setSelectionSetBarriersByRef(ISelectionSetBarriers rhs1)
                                  throws IOException,
                                         AutomationException

Selection set barriers to be used in this solver.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSelectionSetBarriersByRef in interface INetSolver

Parameters:

rhs1 - A reference to a com.esri.arcgis.networkanalysis.ISelectionSetBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableElementClass

public void disableElementClass(int classID)
                         throws IOException,
                                AutomationException

Sets an element class as disabled within this solver.

Remarks

There is no means to reenable an element class that you have disabled with this method. For enabling and disabling element classes for tracing operations use INetworkAnalysisExtBarriers::SetDisabledLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

disableElementClass in interface INetSolver

Parameters:

classID - The classID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.