ArcFM Engine Developer Guide
TraceDownstream 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.

A value from the mmDirectionInfo enumeration. This value, used in conjuction with the startEID and startElementType (or upstreamNeighborEID and upstreamNeighborElementType) values, determines the direction of the trace.

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

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

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.

This boolean argument can be used to include or exclude any junctions that were reached by the trace, but whose status stopped the trace from continuing beyond the junction (no phases continued through the junction). True = exclude open devices; False = include open devices

Returns IMMTracedElements, a collection of individual IMMTracedElement objects for junctions encountered during the trace.

Returns IMMTracedElements, a collection of individual IMMTracedElement objects for edge encountered during the trace.

This method traces downstream of the Start Element. However, the directionInfo argument may be set to allow this method to trace in all directions.
Syntax
'Declaration
 
Sub TraceDownstream( _
   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 directionInfo As mmDirectionInfo, _
   ByVal upstreamNeighborEID As Integer, _
   ByVal upstreamNeighborElementType As ESRI.ArcGIS.Geodatabase.esriElementType, _
   ByVal barrierJunctions As Object, _
   ByVal barrierEdges As Object, _
   ByVal excludeOpenDevices As Boolean, _
   ByRef tracedJunctions As IMMTracedElements, _
   ByRef tracedEdges 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 directionInfo As mmDirectionInfo
Dim upstreamNeighborEID As Integer
Dim upstreamNeighborElementType As ESRI.ArcGIS.Geodatabase.esriElementType
Dim barrierJunctions As Object
Dim barrierEdges As Object
Dim excludeOpenDevices As Boolean
Dim tracedJunctions As IMMTracedElements
Dim tracedEdges As IMMTracedElements
 
instance.TraceDownstream(GeometricNetwork, settings, currentStatus, startEID, startElementType, Phases, directionInfo, upstreamNeighborEID, upstreamNeighborElementType, barrierJunctions, barrierEdges, excludeOpenDevices, tracedJunctions, tracedEdges)
void TraceDownstream( 
   ESRI.ArcGIS.Geodatabase.IGeometricNetwork GeometricNetwork,
   IMMElectricTraceSettings settings,
   IMMCurrentStatus currentStatus,
   int startEID,
   ESRI.ArcGIS.Geodatabase.esriElementType startElementType,
   SetOfPhases Phases,
   mmDirectionInfo directionInfo,
   int upstreamNeighborEID,
   ESRI.ArcGIS.Geodatabase.esriElementType upstreamNeighborElementType,
   object barrierJunctions,
   object barrierEdges,
   bool excludeOpenDevices,
   out IMMTracedElements tracedJunctions,
   out IMMTracedElements tracedEdges
)

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.

directionInfo

A value from the mmDirectionInfo enumeration. This value, used in conjuction with the startEID and startElementType (or upstreamNeighborEID and upstreamNeighborElementType) values, determines the direction of the trace.

upstreamNeighborEID

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

upstreamNeighborElementType

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

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.

excludeOpenDevices

This boolean argument can be used to include or exclude any junctions that were reached by the trace, but whose status stopped the trace from continuing beyond the junction (no phases continued through the junction). True = exclude open devices; False = include open devices

tracedJunctions

Returns IMMTracedElements, a collection of individual IMMTracedElement objects for junctions encountered during the trace.

tracedEdges

Returns IMMTracedElements, a collection of individual IMMTracedElement objects for edge encountered during the trace.

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