|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.esri.arcgis.networkanalysis.TraceFlowSolver
A collection of basic trace flow solvers used to analyze networks.
| 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. |
|
| 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. |
INetSolver |
getAsINetSolver()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
INetSolverWeightsGEN |
getAsINetSolverWeightsGEN()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
ISupportErrorInfo |
getAsISupportErrorInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
ITraceFlowSolverGEN |
getAsITraceFlowSolverGEN()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
static java.lang.String |
getClsid()
|
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
Supported Platforms |
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,
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 |
public TraceFlowSolver()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public TraceFlowSolver(java.lang.Object obj)
throws java.io.IOException
obj to TraceFlowSolver. TraceFlowSolver theTraceFlowSolver = (TraceFlowSolver) obj;
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
public static java.lang.String getClsid()
public INetSolverWeightsGEN getAsINetSolverWeightsGEN()
public ITraceFlowSolverGEN getAsITraceFlowSolverGEN()
public INetSolver getAsINetSolver()
public ISupportErrorInfo getAsISupportErrorInfo()
public boolean equals(java.lang.Object o)
public int hashCode()
public void setJunctionWeightByRef(INetWeight rhs1)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setJunctionWeightByRef in interface INetSolverWeightsGENrhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setFromToEdgeWeightByRef(INetWeight rhs1)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setFromToEdgeWeightByRef in interface INetSolverWeightsGENrhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setToFromEdgeWeightByRef(INetWeight rhs1)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setToFromEdgeWeightByRef in interface INetSolverWeightsGENrhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setJunctionFilterWeightByRef(INetWeight rhs1)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setJunctionFilterWeightByRef in interface INetSolverWeightsGENrhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setFromToEdgeFilterWeightByRef(INetWeight rhs1)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setFromToEdgeFilterWeightByRef in interface INetSolverWeightsGENrhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setToFromEdgeFilterWeightByRef(INetWeight rhs1)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setToFromEdgeFilterWeightByRef in interface INetSolverWeightsGENrhs1 - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFilterType(int elementType,
int weightFilterType,
boolean applyNotOperator)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setFilterType in interface INetSolverWeightsGENelementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)weightFilterType - A com.esri.arcgis.networkanalysis.esriWeightFilterType constant (in)applyNotOperator - The applyNotOperator (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setFilterRanges(int elementType,
java.lang.Object[] fromValues,
java.lang.Object[] toValues)
throws java.io.IOException,
AutomationException
INetSolverWeightsGEN
setFilterRanges in interface INetSolverWeightsGENelementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)fromValues - A Variant (in)toValues - A Variant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTraceIndeterminateFlow(boolean rhs1)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
setTraceIndeterminateFlow in interface ITraceFlowSolverGENrhs1 - The rhs1 (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void putJunctionOrigins(IJunctionFlag[] junctionOrigins)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGEN
putJunctionOrigins in interface ITraceFlowSolverGENjunctionOrigins - A reference to a com.esri.arcgis.networkanalysis.IJunctionFlag array (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void putEdgeOrigins(IEdgeFlag[] edgeOrigins)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGEN
putEdgeOrigins in interface ITraceFlowSolverGENedgeOrigins - A reference to a com.esri.arcgis.networkanalysis.IEdgeFlag array (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findFlowElements(int flowMethod,
int flowElements,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findFlowElements in interface ITraceFlowSolverGENflowMethod - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void findFlowEndElements(int flowMethod,
int flowElements,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findFlowEndElements in interface ITraceFlowSolverGENflowMethod - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void findPath(int flowMethod,
int objFn,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs,
int count,
java.lang.Object[][] segmentCosts)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findPath in interface ITraceFlowSolverGENflowMethod - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void findCircuits(int flowElements,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findCircuits in interface ITraceFlowSolverGENflowElements - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void findCommonAncestors(int flowElements,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findCommonAncestors in interface ITraceFlowSolverGENflowElements - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findFlowUnreachedElements(int flowMethod,
int flowElements,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findFlowUnreachedElements in interface ITraceFlowSolverGENflowMethod - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void findSource(int flowMethod,
int objFn,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs,
int count,
java.lang.Object[][] segmentCosts)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findSource in interface ITraceFlowSolverGENflowMethod - 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)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void findAccumulation(int flowMethod,
int flowElements,
IEnumNetEID[] junctionEIDs,
IEnumNetEID[] edgeEIDs,
java.lang.Object[] pTotalCost)
throws java.io.IOException,
AutomationException
ITraceFlowSolverGENThe 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.
findAccumulation in interface ITraceFlowSolverGENflowMethod - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSourceNetworkByRef(INetwork rhs1)
throws java.io.IOException,
AutomationException
INetSolver
setSourceNetworkByRef in interface INetSolverrhs1 - A reference to a com.esri.arcgis.geodatabase.INetwork (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setElementBarriersByRef(int elementType,
INetElementBarriers rhs2)
throws java.io.IOException,
AutomationException
INetSolver
setElementBarriersByRef in interface INetSolverelementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)rhs2 - A reference to a com.esri.arcgis.networkanalysis.INetElementBarriers (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSelectionSetBarriersByRef(ISelectionSetBarriers rhs1)
throws java.io.IOException,
AutomationException
INetSolver
setSelectionSetBarriersByRef in interface INetSolverrhs1 - A reference to a com.esri.arcgis.networkanalysis.ISelectionSetBarriers (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void disableElementClass(int classID)
throws java.io.IOException,
AutomationException
INetSolver
disableElementClass in interface INetSolverclassID - The classID (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void interfaceSupportsErrorInfo(GUID riid)
throws java.io.IOException,
AutomationException
ISupportErrorInfoIndicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||