ArcFM Engine Developer Guide
FindFeedPathsShowWork Method (IMMElectricTracingEx)


An IGeometricNetwork object that specifies the network model on which the tracing is to be performed.

An IMMElectricTraceSettings object that specifies some interpretation policies to be applied to the network's elements.

Optional. An IMMCurrentStatus object that instructs the trace how to behave when it encounters a junction or edge while tracing. If your tracing application is straightforward and uses a normal switch status as reflected in the MMElectricTraceWeight value of each junction and edge feature, you can supply null (C#) or Nothing (VB) for this parameter.

A long integer that specifies the starting point of the trace. This is the Esri Network Element ID of the start element (a 32-bit integer).

A value from the esriElementType enumeration that indicates whether the startEID value is the ID of a junction or an edge.

A value from the SetOfPhases enumeration that indicates the phase of the encountered edge or junction.

Specifies the ID of a junction (as Variant) that constitutes a barrier to all electrical phases; when the trace encounters a barrier element, it must terminate the path at that point.

Specifies the ID of an edge (as Variant) that constitutes a barrier to all electrical phases; when the trace encounters a barrier element, it must terminate the path at that point.

Boolean value indicating whether to display visited junctions and edges that did not lead to a circuit source feature. True = shows these features only if no feed path was found; False = shows these features regardless of whether a feed path was found.

An IMMEnumFeedPath object is returned for each distinct circuit source feature that is reached by the search

FindFeedPaths also reports on every network element that blocked one or more electrical phases while searching for paths to sources. This argument returns an array of IMMEnumTraceStopper objects for junctions that blocked the trace.

FindFeedPaths also reports on every network element that blocked one or more electrical phases while searching for paths to sources. This argument returns an array of IMMEnumTraceStopper objects for edges that blocked the trace.

This argument returns an array of IMMTracedElements objects for junctions that were encountered during the trace whether they were part of a path to the circuit source feature or not.

This argument returns an array of IMMTracedElements objects for edges that were encountered during the trace whether they were part of a path to the circuit source feature or not.

This method traces all possible paths to all possible sources. It differs from the FindFeedPaths method in that, FindFeedPathsShowWork returns every junction and edge that was visited during the search for paths.
Syntax
'Declaration
 
Sub FindFeedPathsShowWork( _
   ByVal GeometricNetwork As ESRI.ArcGIS.Geodatabase.IGeometricNetwork, _
   ByVal settings As IMMElectricTraceSettings, _
   ByVal currentStatus As IMMCurrentStatus, _
   ByVal startEID As Integer, _
   ByVal startElementType As ESRI.ArcGIS.Geodatabase.esriElementType, _
   ByVal Phases As SetOfPhases, _
   ByVal barrierJunctions As Object, _
   ByVal barrierEdges As Object, _
   ByVal showWorkOnlyIfNoFeedpathExists As Boolean, _
   ByRef feedPaths As IMMEnumFeedPath, _
   ByRef traceStopperJunctions As IMMEnumTraceStopper, _
   ByRef traceStopperEdges As IMMEnumTraceStopper, _
   ByRef visitedJunctions As IMMTracedElements, _
   ByRef visitedEdges As IMMTracedElements _
) 
'Usage
 
Dim instance As IMMElectricTracingEx
Dim GeometricNetwork As ESRI.ArcGIS.Geodatabase.IGeometricNetwork
Dim settings As IMMElectricTraceSettings
Dim currentStatus As IMMCurrentStatus
Dim startEID As Integer
Dim startElementType As ESRI.ArcGIS.Geodatabase.esriElementType
Dim Phases As SetOfPhases
Dim barrierJunctions As Object
Dim barrierEdges As Object
Dim showWorkOnlyIfNoFeedpathExists As Boolean
Dim feedPaths As IMMEnumFeedPath
Dim traceStopperJunctions As IMMEnumTraceStopper
Dim traceStopperEdges As IMMEnumTraceStopper
Dim visitedJunctions As IMMTracedElements
Dim visitedEdges As IMMTracedElements
 
instance.FindFeedPathsShowWork(GeometricNetwork, settings, currentStatus, startEID, startElementType, Phases, barrierJunctions, barrierEdges, showWorkOnlyIfNoFeedpathExists, feedPaths, traceStopperJunctions, traceStopperEdges, visitedJunctions, visitedEdges)
void FindFeedPathsShowWork( 
   ESRI.ArcGIS.Geodatabase.IGeometricNetwork GeometricNetwork,
   IMMElectricTraceSettings settings,
   IMMCurrentStatus currentStatus,
   int startEID,
   ESRI.ArcGIS.Geodatabase.esriElementType startElementType,
   SetOfPhases Phases,
   object barrierJunctions,
   object barrierEdges,
   bool showWorkOnlyIfNoFeedpathExists,
   out IMMEnumFeedPath feedPaths,
   out IMMEnumTraceStopper traceStopperJunctions,
   out IMMEnumTraceStopper traceStopperEdges,
   out IMMTracedElements visitedJunctions,
   out IMMTracedElements visitedEdges
)

Parameters

GeometricNetwork

An IGeometricNetwork object that specifies the network model on which the tracing is to be performed.

settings

An IMMElectricTraceSettings object that specifies some interpretation policies to be applied to the network's elements.

currentStatus

Optional. An IMMCurrentStatus object that instructs the trace how to behave when it encounters a junction or edge while tracing. If your tracing application is straightforward and uses a normal switch status as reflected in the MMElectricTraceWeight value of each junction and edge feature, you can supply null (C#) or Nothing (VB) for this parameter.

startEID

A long integer that specifies the starting point of the trace. This is the Esri Network Element ID of the start element (a 32-bit integer).

startElementType

A value from the esriElementType enumeration that indicates whether the startEID value is the ID of a junction or an edge.

Phases

A value from the SetOfPhases enumeration that indicates the phase of the encountered edge or junction.

barrierJunctions

Specifies the ID of a junction (as Variant) that constitutes a barrier to all electrical phases; when the trace encounters a barrier element, it must terminate the path at that point.

barrierEdges

Specifies the ID of an edge (as Variant) that constitutes a barrier to all electrical phases; when the trace encounters a barrier element, it must terminate the path at that point.

showWorkOnlyIfNoFeedpathExists

Boolean value indicating whether to display visited junctions and edges that did not lead to a circuit source feature. True = shows these features only if no feed path was found; False = shows these features regardless of whether a feed path was found.

feedPaths

An IMMEnumFeedPath object is returned for each distinct circuit source feature that is reached by the search

traceStopperJunctions

FindFeedPaths also reports on every network element that blocked one or more electrical phases while searching for paths to sources. This argument returns an array of IMMEnumTraceStopper objects for junctions that blocked the trace.

traceStopperEdges

FindFeedPaths also reports on every network element that blocked one or more electrical phases while searching for paths to sources. This argument returns an array of IMMEnumTraceStopper objects for edges that blocked the trace.

visitedJunctions

This argument returns an array of IMMTracedElements objects for junctions that were encountered during the trace whether they were part of a path to the circuit source feature or not.

visitedEdges

This argument returns an array of IMMTracedElements objects for edges that were encountered during the trace whether they were part of a path to the circuit source feature or not.

Requirements

Target Platforms: Windows XP SP3 (32-bit and 64-bit), Windows 7 (32-bit and 64-bit)

Not all Operating Systems are supported on all products. Visit the ArcFM Solution Supported Versions page for full details.

See Also

Reference

IMMElectricTracingEx Interface
IMMElectricTracingEx Members

 

 


Send Comment