com.esri.arcgis.networkanalysis
Class TraceFlowSolver

java.lang.Object
  extended by com.esri.arcgis.networkanalysis.TraceFlowSolver
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INetSolver, INetSolverWeightsGEN, ITraceFlowSolverGEN, ISupportErrorInfo, java.io.Serializable

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

COM Class 'TraceFlowSolver'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriNetworkAnalysis.olb'

Description 'A collection of basic trace flow solvers used to analyze networks.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.networkanalysis.INetSolverWeightsGEN
IID, IIDf00759f5_60c0_4077_bd1b_61b49c47ac7a, xxDummy
 
Fields inherited from interface com.esri.arcgis.networkanalysis.ITraceFlowSolverGEN
IID, IID625024ca_7e97_41df_abf5_f1c434b7dbc2, xxDummy
 
Fields inherited from interface com.esri.arcgis.networkanalysis.INetSolver
IID, IID54fb1502_a640_11d0_9cc9_00805f74d243, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
TraceFlowSolver()
          Constructs a TraceFlowSolver using ArcGIS Engine.
TraceFlowSolver(java.lang.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(java.lang.Object o)
          Compare this object with another
 void findAccumulation(int flowMethod, int flowElements, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs, java.lang.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, java.lang.Object[][] segmentCosts)
          Finds a path between the specified origins in the network.
 void findSource(int flowMethod, int objFn, IEnumNetEID[] junctionEIDs, IEnumNetEID[] edgeEIDs, int count, java.lang.Object[][] segmentCosts)
          Finds a path upstream to a source or downstream to a sink, depending on the specified flow method.
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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 release()
          Release a TraceFlowSolver.
 void setElementBarriersByRef(int elementType, INetElementBarriers rhs2)
          Network element barrier set to be used in this solver.
 void setFilterRanges(int elementType, java.lang.Object[] fromValues, java.lang.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
 

Constructor Detail

TraceFlowSolver

public TraceFlowSolver()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a TraceFlowSolver using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

TraceFlowSolver

public TraceFlowSolver(java.lang.Object obj)
                throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a TraceFlowSolver.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setJunctionWeightByRef

public void setJunctionWeightByRef(INetWeight rhs1)
                            throws java.io.IOException,
                                   AutomationException
Weight to be used to determine the cost of passing through junction elements.

Specified by:
setJunctionWeightByRef in interface INetSolverWeightsGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromToEdgeWeightByRef

public void setFromToEdgeWeightByRef(INetWeight rhs1)
                              throws java.io.IOException,
                                     AutomationException
Weight to be used to determine the cost of passing through edge elements in the digitized direction.

Specified by:
setFromToEdgeWeightByRef in interface INetSolverWeightsGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setToFromEdgeWeightByRef

public void setToFromEdgeWeightByRef(INetWeight rhs1)
                              throws java.io.IOException,
                                     AutomationException
Weight to be used to determine the cost of passing through edge elements against the digitized direction.

Specified by:
setToFromEdgeWeightByRef in interface INetSolverWeightsGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJunctionFilterWeightByRef

public void setJunctionFilterWeightByRef(INetWeight rhs1)
                                  throws java.io.IOException,
                                         AutomationException
Weight to be used for filtering junction elements.

Specified by:
setJunctionFilterWeightByRef in interface INetSolverWeightsGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromToEdgeFilterWeightByRef

public void setFromToEdgeFilterWeightByRef(INetWeight rhs1)
                                    throws java.io.IOException,
                                           AutomationException
Weight to be used for filtering edge elements traced in the digitized direction.

Specified by:
setFromToEdgeFilterWeightByRef in interface INetSolverWeightsGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setToFromEdgeFilterWeightByRef

public void setToFromEdgeFilterWeightByRef(INetWeight rhs1)
                                    throws java.io.IOException,
                                           AutomationException
Weight to be used for filtering edge elements traced against the digitized direction.

Specified by:
setToFromEdgeFilterWeightByRef in interface INetSolverWeightsGEN
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
Throws:
java.io.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 java.io.IOException,
                          AutomationException
Sets the filter type for the specified network element type.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterRanges

public void setFilterRanges(int elementType,
                            java.lang.Object[] fromValues,
                            java.lang.Object[] toValues)
                     throws java.io.IOException,
                            AutomationException
Sets the range of values to be filtered for the specified network element type.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTraceIndeterminateFlow

public void setTraceIndeterminateFlow(boolean rhs1)
                               throws java.io.IOException,
                                      AutomationException
Indicates if directional traces include edges with indeterminate or uninitialized flow direction.

Specified by:
setTraceIndeterminateFlow in interface ITraceFlowSolverGEN
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putJunctionOrigins

public void putJunctionOrigins(IJunctionFlag[] junctionOrigins)
                        throws java.io.IOException,
                               AutomationException
Sets the starting junctions for this trace solver.

Specified by:
putJunctionOrigins in interface ITraceFlowSolverGEN
Parameters:
junctionOrigins - A reference to a com.esri.arcgis.networkanalysis.IJunctionFlag array (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putEdgeOrigins

public void putEdgeOrigins(IEdgeFlag[] edgeOrigins)
                    throws java.io.IOException,
                           AutomationException
Sets the starting edges for this trace solver.

Specified by:
putEdgeOrigins in interface ITraceFlowSolverGEN
Parameters:
edgeOrigins - A reference to a com.esri.arcgis.networkanalysis.IEdgeFlag array (in)
Throws:
java.io.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 java.io.IOException,
                             AutomationException
Finds all reachable network elements based on the specified flow method.

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:
java.io.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 java.io.IOException,
                                AutomationException
Finds all reachable network end elements based on the specified flow method.

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:
java.io.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,
                     java.lang.Object[][] segmentCosts)
              throws java.io.IOException,
                     AutomationException
Finds a path between the specified origins in the network.

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:
java.io.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 java.io.IOException,
                         AutomationException
Finds all reachable network elements that are parts of closed circuits in the network.

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:
java.io.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 java.io.IOException,
                                AutomationException
Finds all reachable network elements that are upstream from all the specified origins.

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:
java.io.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 java.io.IOException,
                                      AutomationException
Finds all unreachable network elements based on the flow method.

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:
java.io.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,
                       java.lang.Object[][] segmentCosts)
                throws java.io.IOException,
                       AutomationException
Finds a path upstream to a source or downstream to a sink, depending on the specified flow method.

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:
java.io.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,
                             java.lang.Object[] pTotalCost)
                      throws java.io.IOException,
                             AutomationException
Finds the total cost of all reachable network elements based on the specified flow method.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceNetworkByRef

public void setSourceNetworkByRef(INetwork rhs1)
                           throws java.io.IOException,
                                  AutomationException
Source network to be used in this solver.

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

setElementBarriersByRef

public void setElementBarriersByRef(int elementType,
                                    INetElementBarriers rhs2)
                             throws java.io.IOException,
                                    AutomationException
Network element barrier set to be used in this solver.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSetBarriersByRef

public void setSelectionSetBarriersByRef(ISelectionSetBarriers rhs1)
                                  throws java.io.IOException,
                                         AutomationException
Selection set barriers to be used in this solver.

Specified by:
setSelectionSetBarriersByRef in interface INetSolver
Parameters:
rhs1 - A reference to a com.esri.arcgis.networkanalysis.ISelectionSetBarriers (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disableElementClass

public void disableElementClass(int classID)
                         throws java.io.IOException,
                                AutomationException
Sets an element class as disabled within this solver.

Specified by:
disableElementClass in interface INetSolver
Parameters:
classID - The classID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.