Interface IUtilityNetworkQuery

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

Provides access to members that query the elements of the utility network.

[Guid("7342C13E-0F9B-44D6-A210-1EEC7295B4CD")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IUtilityNetworkQuery

Properties

AttributeByName[string]

Returns the network attribute with the given name.

IUtilityNetworkAttribute AttributeByName[string Name] { get; }

Parameters

Name string

Property Value

IUtilityNetworkAttribute

AttributeValueByName[esriElementType, long, string]

Returns the value of this network element for the given network attribute name.

object AttributeValueByName[esriElementType ElementType, long EID, string AttributeName] { get; }

Parameters

ElementType esriElementType
EID long
AttributeName string

Property Value

object

AttributeValueByUsageType[esriElementType, long, esriUtilityNetworkAttributeUsageType]

Returns the value of this network element for the given network attribute usage type.

object AttributeValueByUsageType[esriElementType ElementType, long EID, esriUtilityNetworkAttributeUsageType UsageType] { get; }

Parameters

ElementType esriElementType
EID long
UsageType esriUtilityNetworkAttributeUsageType

Property Value

object

Remarks

This method is used to access the internal network attributes such as Source Id, Asset Group, and AssetTYpe by usage type.

Geometry[esriElementType, long]

Returns the geometry in the utility network corresponding to the given element ID.

IGeometry Geometry[esriElementType ElementType, long EID] { get; }

Parameters

ElementType esriElementType
EID long

Property Value

IGeometry

HasDirtyElement[long[], long[]]

Returns whether any of the given set of junction and edge elements correspond to a feature in the dirty area table.

bool HasDirtyElement[long[] junctionEIDs, long[] edgeEIDs] { get; }

Parameters

junctionEIDs long[]
edgeEIDs long[]

Property Value

bool

IsSpatial[int]

Returns whether the network source corresponding to the given network source ID is spatial.

bool IsSpatial[int NetworkSourceID] { get; }

Parameters

NetworkSourceID int

Property Value

bool

Methods

AllEIDs(out long[], out int[])

Returns all network index EIDs.

void AllEIDs(out long[] EIDs, out int[] ElementTypes)

Parameters

EIDs long[]
ElementTypes int[]

DirtyFeaturesOrObjects(ILongLongArray, ILongLongArray, out ILongArray, out IStringArray)

Return the corresponding network source ID and global ID information for any of the given set of junction and edge elements that are dirty based on matching global IDs in the dirty area table or relevant status bits set in the associations table.

void DirtyFeaturesOrObjects(ILongLongArray junctionEIDs, ILongLongArray edgeEIDs, out ILongArray dirtyNetworkSourceIDs, out IStringArray dirtyGlobalIDs)

Parameters

junctionEIDs ILongLongArray
edgeEIDs ILongLongArray
dirtyNetworkSourceIDs ILongArray
dirtyGlobalIDs IStringArray

Elements(Guid, out object, out object)

Returns the elements in the utility network corresponding to the given source objects.

void Elements(Guid GlobalID, out object EIDs, out object ElementTypes)

Parameters

GlobalID Guid
EIDs object
ElementTypes object

ElementsForSet(string[], out object, out object)

Returns the elements in the utility network corresponding to the given source objects.

void ElementsForSet(string[] GlobalIDs, out object EIDs, out object ElementTypes)

Parameters

GlobalIDs string[]
EIDs object
ElementTypes object

FlowDirections(IEnvelope, int, out IArray)

Returns the flow directions.

void FlowDirections(IEnvelope Extent, int maxFlowDirectionCount, out IArray arrows)

Parameters

Extent IEnvelope
maxFlowDirectionCount int
arrows IArray

IsSourceElementDirty(esriElementType, long)

Returns whether the feature that the source element represents is dirty.

bool IsSourceElementDirty(esriElementType ElementType, long EID)

Parameters

ElementType esriElementType
EID long

Returns

bool

IsValidEID(esriElementType, long)

Returns whether the specified element is part of the network.

bool IsValidEID(esriElementType ElementType, long EID)

Parameters

ElementType esriElementType
EID long

Returns

bool

QueryAdjacentEdgesJunctions(long, out object, out object)

Performs a network edge element query by element ID and edge direction and populates the given edge element object.

void QueryAdjacentEdgesJunctions(long junctionEID, out object adjacentEdges, out object adjacentJunctions)

Parameters

junctionEID long
adjacentEdges object
adjacentJunctions object

Remarks

The QueryAdjacentEdgesJunctions method retrieves both internal and external edges that are linked to a terminal within a device. In the network index, a device with two terminals is depicted as two junctions and an internal edge connecting them. These components all have the same source ID or GUID.

For example, in the US, distribution transformers have two terminals and one internal edge, while European distribution systems use three-terminal transformers, which have three internal edges.

QueryAdjacentEdgesJunctionsWithWeights(long, bool, out object, out object, out ILongLongArray, out IVariantArray, out esriJunctionConnectivityStatus, out IArray, out IArray)

Performs a network edge element query by element ID and edge direction and populates the given edge element object.

void QueryAdjacentEdgesJunctionsWithWeights(long junctionEID, bool traversabilityBased, out object adjacentEdges, out object adjacentJunctions, out ILongLongArray currentJunctionWeightIDs, out IVariantArray currentJunctionWeightValues, out esriJunctionConnectivityStatus junctionConnectivityStatus, out IArray edgeWeightIDs, out IArray edgeWeightValues)

Parameters

junctionEID long
traversabilityBased bool
adjacentEdges object
adjacentJunctions object
currentJunctionWeightIDs ILongLongArray
currentJunctionWeightValues IVariantArray
junctionConnectivityStatus esriJunctionConnectivityStatus
edgeWeightIDs IArray
edgeWeightValues IArray

QueryFromToJunctions(long, out long, out long)

Queries the two end junction element IDs by edge element ID.

void QueryFromToJunctions(long edgeEID, out long FromJunctionEID, out long ToJunctionEID)

Parameters

edgeEID long
FromJunctionEID long
ToJunctionEID long

QueryGeometries(esriElementType, ILongLongArray, IDoubleArray, IDoubleArray)

Query geometries for the given network elements.

IArray QueryGeometries(esriElementType ElementType, ILongLongArray EIDs, IDoubleArray overridePositionFroms, IDoubleArray overridePositionTos)

Parameters

ElementType esriElementType
EIDs ILongLongArray
overridePositionFroms IDoubleArray
overridePositionTos IDoubleArray

Returns

IArray

QueryJunctionConnectivityStatus(long, out esriJunctionConnectivityStatus)

Returns the junction connectivity status.

void QueryJunctionConnectivityStatus(long junctionEID, out esriJunctionConnectivityStatus junctionConnectivityStatus)

Parameters

junctionEID long
junctionConnectivityStatus esriJunctionConnectivityStatus

SourceFeatureGlobalID(esriElementType, long, out int, out Guid)

Performs a network source feature query for globalID by element ID.

void SourceFeatureGlobalID(esriElementType ElementType, long EID, out int SourceID, out Guid GlobalID)

Parameters

ElementType esriElementType
EID long
SourceID int
GlobalID Guid

SourceFeatureOID(esriElementType, long, out int, out int)

Performs a network source feature query for OID by element ID.

void SourceFeatureOID(esriElementType ElementType, long EID, out int SourceID, out int ObjectID)

Parameters

ElementType esriElementType
EID long
SourceID int
ObjectID int