Interface IUtilityNetworkQueryTracer

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

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

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("190CCDAB-1679-4923-BC92-7D91D69B9189")]
public interface IUtilityNetworkQueryTracer

Properties

TraceConfiguration[int]

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

IUNTraceConfiguration TraceConfiguration[int TierID] { get; }

Parameters

TierID int

Property Value

IUNTraceConfiguration

Methods

AttributeNameToWeightIDMapping(esriElementType, out IStringArray, out ILongArray)

Returns the attribute name to weight ID mappings.

void AttributeNameToWeightIDMapping(esriElementType ElementType, out IStringArray attributeNames, out ILongArray weightIDs)

Parameters

ElementType esriElementType
attributeNames IStringArray
weightIDs ILongArray

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.

[C#]

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];

}

AttributeUsageTypeToWeightIDMapping(esriElementType, out ILongArray, out ILongArray)

Returns the attribute usage type to weight ID mappings.

void AttributeUsageTypeToWeightIDMapping(esriElementType ElementType, out ILongArray attributeUsageTypes, out ILongArray weightIDs)

Parameters

ElementType esriElementType
attributeUsageTypes ILongArray
weightIDs ILongArray

AttributesForFeatures(esriElementType, ILongLongArray, bool, IStringArray, IArray, out ILongArray, out IStringArray, out ILongArray, out ILongArray, out ILongArray, out ILongArray, out IDoubleArray, out IDoubleArray, out IArray, out IArray, out IArray)

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

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

Parameters

ElementType esriElementType
EIDs ILongLongArray
IncludeGeometry bool
NetworkAttributeNames IStringArray
ResultTypeFields IArray
networkSourceIDs ILongArray
GlobalIDs IStringArray
objectIDs ILongArray
TerminalIDs ILongArray
AssetGroupCodes ILongArray
assetTypeCodes ILongArray
positionFroms IDoubleArray
positionTos IDoubleArray
geometries IArray
networkAttributeValues IArray
fieldValues IArray

Remarks

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

ConnectivityFeatures(ILongLongArray, bool, out ILongArray, out IStringArray, out ILongArray, out IDoubleArray, out IDoubleArray, out IArray, out ILongArray, out IStringArray, out ILongArray, out ILongArray, out IArray, out ILongArray, out IStringArray, out ILongArray, out ILongArray, out IArray)

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

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

Parameters

edgeEIDs ILongLongArray
IncludeGeometry bool
viaNetworkSourceIDs ILongArray
viaGlobalIDs IStringArray
viaObjectIDs ILongArray
viaPositionFroms IDoubleArray
viaPositionTos IDoubleArray
viaGeometries IArray
fromNetworkSourceIDs ILongArray
fromGlobalIDs IStringArray
fromObjectIDs ILongArray
fromTerminalIDs ILongArray
fromGeometries IArray
toNetworkSourceIDs ILongArray
toGlobalIDs IStringArray
toObjectIDs ILongArray
toTerminalIDs ILongArray
toGeometries IArray

Remarks

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

ElementsToFeatures(esriElementType, long[], out int[], out string[])

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

void ElementsToFeatures(esriElementType ElementType, long[] EIDs, out int[] sourceIDs, out string[] GlobalIDs)

Parameters

ElementType esriElementType
EIDs long[]
sourceIDs int[]
GlobalIDs string[]

FeaturesForSet(esriElementType, ILongLongArray, out ILongArray, out IStringArray, out ILongArray, out ILongArray, out ILongArray, out ILongArray)

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

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

Parameters

ElementType esriElementType
EIDs ILongLongArray
networkSourceIDs ILongArray
GlobalIDs IStringArray
objectIDs ILongArray
TerminalIDs ILongArray
AssetGroupCodes ILongArray
assetTypeCodes ILongArray

FeaturesForSetBasic(esriElementType, ILongLongArray, out ILongArray, out IStringArray, out ILongArray)

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

void FeaturesForSetBasic(esriElementType ElementType, ILongLongArray EIDs, out ILongArray networkSourceIDs, out IStringArray GlobalIDs, out ILongArray objectIDs)

Parameters

ElementType esriElementType
EIDs ILongLongArray
networkSourceIDs ILongArray
GlobalIDs IStringArray
objectIDs ILongArray

FeaturesForSetBasicWithPosition(esriElementType, ILongLongArray, out ILongArray, out IStringArray, out ILongArray, out IDoubleArray, out IDoubleArray)

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

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

Parameters

ElementType esriElementType
EIDs ILongLongArray
networkSourceIDs ILongArray
GlobalIDs IStringArray
objectIDs ILongArray
positionFroms IDoubleArray
positionTos IDoubleArray

FeaturesForSetWithPosition(esriElementType, ILongLongArray, out ILongArray, out IStringArray, out ILongArray, out ILongArray, out ILongArray, out ILongArray, out IDoubleArray, out IDoubleArray)

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.

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

Parameters

ElementType esriElementType
EIDs ILongLongArray
networkSourceIDs ILongArray
GlobalIDs IStringArray
objectIDs ILongArray
TerminalIDs ILongArray
AssetGroupCodes ILongArray
assetTypeCodes ILongArray
positionFroms IDoubleArray
positionTos IDoubleArray

GetIntersectingElements(esriElementType, IGeometry, ref long[])

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

void GetIntersectingElements(esriElementType ElementType, IGeometry Geometry, ref long[] EIDs)

Parameters

ElementType esriElementType
Geometry IGeometry
EIDs long[]

GetIntersectingElementsWithPercentAlong(esriElementType, IGeometry, out ILongLongArray, out IDoubleArray)

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

void GetIntersectingElementsWithPercentAlong(esriElementType ElementType, IGeometry Geometry, out ILongLongArray EIDs, out IDoubleArray percentAlongs)

Parameters

ElementType esriElementType
Geometry IGeometry
EIDs ILongLongArray
percentAlongs IDoubleArray

QueryTraceConfiguration(Guid, out esriUtilityNetworkTraceType, out ITraceConfiguration, out IArray)

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

void QueryTraceConfiguration(Guid GlobalID, out esriUtilityNetworkTraceType traceType, out ITraceConfiguration TraceConfiguration, out IArray ResultTypes)

Parameters

GlobalID Guid
traceType esriUtilityNetworkTraceType
TraceConfiguration ITraceConfiguration
ResultTypes IArray