IUtilityNetworkQueryTracer Interface

Provides access to members that supply utility network query tracer information.

Members

	Name	Description
	AttributeNameToWeightIDMapping	Returns the attribute name to weight ID mappings.
	AttributesForFeatures	Returns feature information including geometry, network attribute, and field information.
	AttributeUsageTypeToWeightIDMapping	Returns the attribute usage type to weight ID mappings.
	ConnectivityFeatures	Returns feature information for the given set of edge eids as well as their from and to junctions.
	ElementsToFeatures	Get Source IDs and Global IDs that correspond to the given EIDs.
	FeaturesForSet	Returns Network Source IDs, Global IDs, Object IDs, Terminal IDs, Asset Group Codes, and Asset Type Codes that correspond to the given EIDs.
	FeaturesForSetBasic	Returns Network Source IDs, Global IDs, and Object IDs that correspond to the given EIDs.
	FeaturesForSetBasicWithPosition	Returns Network Source IDs, Global IDs, Object IDs, Position Froms (for edges), and PositionTos (for edges) that correspond to the given EIDs.
	FeaturesForSetWithPosition	Returns Network Source IDs, Global IDs, Object IDs, Terminal IDs, Asset Group Codes, Asset Type Codes, Position Froms (for edges), and PositionTos (for edges) that correspond to the given EIDs.
	GetIntersectingElements	Returns all junction or edge EIDs that are intersecting with a geometry.
	GetIntersectingElementsWithPercentAlong	Returns all junction or edge EIDs that are intersecting with a geometry. Percent alongs are returned with edge EIDs.
	QueryTraceConfiguration	Query the trace configurations table for the trace configuration corresponding to the given global ID.
	TraceConfiguration	Returns the trace configuration for the tier with the given tier ID.

IUtilityNetworkQueryTracer.AttributeNameToWeightIDMapping Property

Returns the attribute name to weight ID mappings.

Public Sub AttributeNameToWeightIDMapping ( _
    ByVal ElementType As esriElementType, _
    ByRef attributeNames As IStringArray, _
    ByRef weightIDs As ILongArray _
)

public void AttributeNameToWeightIDMapping (
    esriElementType ElementType,
    ref IStringArray attributeNames,
    ref ILongArray weightIDs
);

Remarks

Weights are used by the index to store attribute information, and to get an attribute value from the index; you need a weight ID.

private void GetWeightAndAttributeInformation(IBaseNetwork baseNetwork)

{

  IUtilityNetworkQuery utilityNetworkQuery = baseNetwork.CreateQuery();

  IUtilityNetworkQueryTracer utilityNetworkQueryTracer = utilityNetworkQuery as IUtilityNetworkQueryTracer;

  

  IStringArray attributeNames;

  ILongArray weightIDs;

  

  utilityNetworkQueryTracer.AttributeNameToWeightIDMapping(esriElementType.esriETJunction, out attributeNames, out weightIDs);

  

  // Results

  string attributeName = attributeNames?.Element[0];

  int? weight = weightIDs?.Element[0];

}

IUtilityNetworkQueryTracer.AttributesForFeatures Property

Returns feature information including geometry, network attribute, and field information.

Public Sub AttributesForFeatures ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As ILongLongArray, _
    ByVal IncludeGeometry As Boolean, _
    ByVal NetworkAttributeNames As IStringArray, _
    ByVal ResultTypeFields As IArray, _
    ByRef networkSourceIDs As ILongArray, _
    ByRef GlobalIDs As IStringArray, _
    ByRef objectIDs As ILongArray, _
    ByRef TerminalIDs As ILongArray, _
    ByRef AssetGroupCodes As ILongArray, _
    ByRef assetTypeCodes As ILongArray, _
    ByRef positionFroms As IDoubleArray, _
    ByRef positionTos As IDoubleArray, _
    ByRef geometries As IArray, _
    ByRef networkAttributeValues As IArray, _
    ByRef fieldValues As IArray _
)

public void AttributesForFeatures (
    esriElementType ElementType,
    ILongLongArray EIDs,
    bool IncludeGeometry,
    IStringArray NetworkAttributeNames,
    IArray ResultTypeFields,
    ref ILongArray networkSourceIDs,
    ref IStringArray GlobalIDs,
    ref ILongArray objectIDs,
    ref ILongArray TerminalIDs,
    ref ILongArray AssetGroupCodes,
    ref ILongArray assetTypeCodes,
    ref IDoubleArray positionFroms,
    ref IDoubleArray positionTos,
    ref IArray geometries,
    ref IArray networkAttributeValues,
    ref IArray fieldValues
);

Remarks

This is used during export subnetwork. The user can choose to export network attributes directly (networkAttributeValues) or field values (fieldValues).

IUtilityNetworkQueryTracer.AttributeUsageTypeToWeightIDMapping Property

Returns the attribute usage type to weight ID mappings.

Public Sub AttributeUsageTypeToWeightIDMapping ( _
    ByVal ElementType As esriElementType, _
    ByRef attributeUsageTypes As ILongArray, _
    ByRef weightIDs As ILongArray _
)

public void AttributeUsageTypeToWeightIDMapping (
    esriElementType ElementType,
    ref ILongArray attributeUsageTypes,
    ref ILongArray weightIDs
);

IUtilityNetworkQueryTracer.ConnectivityFeatures Property

Returns feature information for the given set of edge eids as well as their from and to junctions.

Public Sub ConnectivityFeatures ( _
    ByVal edgeEIDs As ILongLongArray, _
    ByVal IncludeGeometry As Boolean, _
    ByRef viaNetworkSourceIDs As ILongArray, _
    ByRef viaGlobalIDs As IStringArray, _
    ByRef viaObjectIDs As ILongArray, _
    ByRef viaPositionFroms As IDoubleArray, _
    ByRef viaPositionTos As IDoubleArray, _
    ByRef viaGeometries As IArray, _
    ByRef fromNetworkSourceIDs As ILongArray, _
    ByRef fromGlobalIDs As IStringArray, _
    ByRef fromObjectIDs As ILongArray, _
    ByRef fromTerminalIDs As ILongArray, _
    ByRef fromGeometries As IArray, _
    ByRef toNetworkSourceIDs As ILongArray, _
    ByRef toGlobalIDs As IStringArray, _
    ByRef toObjectIDs As ILongArray, _
    ByRef toTerminalIDs As ILongArray, _
    ByRef toGeometries As IArray _
)

public void ConnectivityFeatures (
    ILongLongArray edgeEIDs,
    bool IncludeGeometry,
    ref ILongArray viaNetworkSourceIDs,
    ref IStringArray viaGlobalIDs,
    ref ILongArray viaObjectIDs,
    ref IDoubleArray viaPositionFroms,
    ref IDoubleArray viaPositionTos,
    ref IArray viaGeometries,
    ref ILongArray fromNetworkSourceIDs,
    ref IStringArray fromGlobalIDs,
    ref ILongArray fromObjectIDs,
    ref ILongArray fromTerminalIDs,
    ref IArray fromGeometries,
    ref ILongArray toNetworkSourceIDs,
    ref IStringArray toGlobalIDs,
    ref ILongArray toObjectIDs,
    ref ILongArray toTerminalIDs,
    ref IArray toGeometries
);

Remarks

This is used during export subnetwork and trace for exporting connectivity information in JSON.

IUtilityNetworkQueryTracer.ElementsToFeatures Method

Get Source IDs and Global IDs that correspond to the given EIDs.

Public Sub ElementsToFeatures ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As Int64[], _
    ByRef sourceIDs As Int32[]&, _
    ByRef GlobalIDs As String[]& _
)

public void ElementsToFeatures (
    esriElementType ElementType,
    Int64[] EIDs,
    ref Int32[]& sourceIDs,
    ref String[]& GlobalIDs
);

IUtilityNetworkQueryTracer.FeaturesForSet Property

Returns Network Source IDs, Global IDs, Object IDs, Terminal IDs, Asset Group Codes, and Asset Type Codes that correspond to the given EIDs.

Public Sub FeaturesForSet ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As ILongLongArray, _
    ByRef networkSourceIDs As ILongArray, _
    ByRef GlobalIDs As IStringArray, _
    ByRef objectIDs As ILongArray, _
    ByRef TerminalIDs As ILongArray, _
    ByRef AssetGroupCodes As ILongArray, _
    ByRef assetTypeCodes As ILongArray _
)

public void FeaturesForSet (
    esriElementType ElementType,
    ILongLongArray EIDs,
    ref ILongArray networkSourceIDs,
    ref IStringArray GlobalIDs,
    ref ILongArray objectIDs,
    ref ILongArray TerminalIDs,
    ref ILongArray AssetGroupCodes,
    ref ILongArray assetTypeCodes
);

IUtilityNetworkQueryTracer.FeaturesForSetBasic Property

Returns Network Source IDs, Global IDs, and Object IDs that correspond to the given EIDs.

Public Sub FeaturesForSetBasic ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As ILongLongArray, _
    ByRef networkSourceIDs As ILongArray, _
    ByRef GlobalIDs As IStringArray, _
    ByRef objectIDs As ILongArray _
)

public void FeaturesForSetBasic (
    esriElementType ElementType,
    ILongLongArray EIDs,
    ref ILongArray networkSourceIDs,
    ref IStringArray GlobalIDs,
    ref ILongArray objectIDs
);

IUtilityNetworkQueryTracer.FeaturesForSetBasicWithPosition Property

Returns Network Source IDs, Global IDs, Object IDs, Position Froms (for edges), and PositionTos (for edges) that correspond to the given EIDs.

Public Sub FeaturesForSetBasicWithPosition ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As ILongLongArray, _
    ByRef networkSourceIDs As ILongArray, _
    ByRef GlobalIDs As IStringArray, _
    ByRef objectIDs As ILongArray, _
    ByRef positionFroms As IDoubleArray, _
    ByRef positionTos As IDoubleArray _
)

public void FeaturesForSetBasicWithPosition (
    esriElementType ElementType,
    ILongLongArray EIDs,
    ref ILongArray networkSourceIDs,
    ref IStringArray GlobalIDs,
    ref ILongArray objectIDs,
    ref IDoubleArray positionFroms,
    ref IDoubleArray positionTos
);

IUtilityNetworkQueryTracer.FeaturesForSetWithPosition Property

Returns Network Source IDs, Global IDs, Object IDs, Terminal IDs, Asset Group Codes, Asset Type Codes, Position Froms (for edges), and PositionTos (for edges) that correspond to the given EIDs.

Public Sub FeaturesForSetWithPosition ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As ILongLongArray, _
    ByRef networkSourceIDs As ILongArray, _
    ByRef GlobalIDs As IStringArray, _
    ByRef objectIDs As ILongArray, _
    ByRef TerminalIDs As ILongArray, _
    ByRef AssetGroupCodes As ILongArray, _
    ByRef assetTypeCodes As ILongArray, _
    ByRef positionFroms As IDoubleArray, _
    ByRef positionTos As IDoubleArray _
)

public void FeaturesForSetWithPosition (
    esriElementType ElementType,
    ILongLongArray EIDs,
    ref ILongArray networkSourceIDs,
    ref IStringArray GlobalIDs,
    ref ILongArray objectIDs,
    ref ILongArray TerminalIDs,
    ref ILongArray AssetGroupCodes,
    ref ILongArray assetTypeCodes,
    ref IDoubleArray positionFroms,
    ref IDoubleArray positionTos
);

IUtilityNetworkQueryTracer.GetIntersectingElements Method

Returns all junction or edge EIDs that are intersecting with a geometry.

Public Sub GetIntersectingElements ( _
    ByVal ElementType As esriElementType, _
    ByVal Geometry As IGeometry, _
    ByRef EIDs As Int64[]& _
)

public void GetIntersectingElements (
    esriElementType ElementType,
    IGeometry Geometry,
    ref Int64[]& EIDs
);

IUtilityNetworkQueryTracer.GetIntersectingElementsWithPercentAlong Method

Returns all junction or edge EIDs that are intersecting with a geometry. Percent alongs are returned with edge EIDs.

Public Sub GetIntersectingElementsWithPercentAlong ( _
    ByVal ElementType As esriElementType, _
    ByVal Geometry As IGeometry, _
    ByRef EIDs As ILongLongArray, _
    ByRef percentAlongs As IDoubleArray _
)

public void GetIntersectingElementsWithPercentAlong (
    esriElementType ElementType,
    IGeometry Geometry,
    ref ILongLongArray EIDs,
    ref IDoubleArray percentAlongs
);

IUtilityNetworkQueryTracer.QueryTraceConfiguration Method

Query the trace configurations table for the trace configuration corresponding to the given global ID.

Public Sub QueryTraceConfiguration ( _
    ByVal GlobalID As Guid, _
    ByRef traceType As esriUtilityNetworkTraceType, _
    ByRef TraceConfiguration As ITraceConfiguration, _
    ByRef ResultTypes As IArray _
)

public void QueryTraceConfiguration (
    Guid GlobalID,
    ref esriUtilityNetworkTraceType traceType,
    ref ITraceConfiguration TraceConfiguration,
    ref IArray ResultTypes
);

IUtilityNetworkQueryTracer.TraceConfiguration Property

Returns the trace configuration for the tier with the given tier ID.

Public Function get_TraceConfiguration ( _
    ByVal TierID As Integer _
) As IUNTraceConfiguration

public IUNTraceConfiguration get_TraceConfiguration (
    int TierID
);

Classes that implement IUtilityNetworkQueryTracer

Classes	Description