com.esri.arcgis.networkanalysis
Interface ITraceFlowSolver2

All Superinterfaces:

ITraceFlowSolver, Serializable

All Known Implementing Classes:

ITraceFlowSolver2Proxy

public interface ITraceFlowSolver2
extends ITraceFlowSolver, Serializable

Provides access to members that perform traces on a network.

Remarks

ITraceFlowSolver2 adds more trace solvers to the TraceFlowSolver object. It can be used in a similar way as the ITraceFlowSolver interface.

Product Availability

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

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

Method Summary

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	findFlowUnreachedElements(int flowMethod, int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs) Finds all unreachable network elements based on the flow method.
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.

Methods inherited from interface com.esri.arcgis.networkanalysis.ITraceFlowSolver

findCircuits, findCommonAncestors, findFlowElements, findFlowEndElements, findPath, putEdgeOrigins, putJunctionOrigins, setTraceIndeterminateFlow

Method Detail

findFlowUnreachedElements

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 ITraceFlowSolver::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.

Supported Platforms

Windows, Solaris, Linux

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

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 ITraceFlowSolver::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.

Supported Platforms

Windows, Solaris, Linux

This method is not callable from Java. Please use ITraceFlowSolverGEN::FindSource.

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

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 ITraceFlowSolver::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.

Supported Platforms

Windows, Solaris, Linux

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.