IUtilityNetworkQuery Interface

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

Members

Name Description
Read-only property AllEIDs Returns all network index EIDs.
Read-only property AttributeByName Returns the network attribute with the given name.
Read-only property AttributeValueByName Returns the value of this network element for the given network attribute name.
Read-only property AttributeValueByUsageType Returns the value of this network element for the given network attribute usage type.
Read-only property DirtyFeaturesOrObjects 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.
Read-only property Elements Returns the elements in the utility network corresponding to the given source objects.
Read-only property ElementsForSet Returns the elements in the utility network corresponding to the given source objects.
Read-only property FlowDirections Returns the flow directions.
Read-only property Geometry Returns the geometry in the utility network corresponding to the given element ID.
Read-only property HasDirtyElement Returns whether any of the given set of junction and edge elements correspond to a feature in the dirty area table.
Method IsSourceElementDirty Returns whether the feature that the source element represents is dirty.
Read-only property IsSpatial Returns whether the network source corresponding to the given network source ID is spatial.
Method IsTraversable Indicates if the given network element is traversable.
Method IsValidEID Returns whether the specified element is part of the network.
Method QueryAdjacentEdgesJunctions Performs a network edge element query by element ID and edge direction and populates the given edge element object.
Method QueryAdjacentEdgesJunctionsWithWeights Performs a network edge element query by element ID and edge direction and populates the given edge element object.
Method QueryFromToJunctions Queries the two end junction element IDs by edge element ID.
Method QueryGeometries Query geometries for the given network elements.
Method QueryJunctionConnectivityStatus Returns the junction connectivity status.
Read-only property SourceFeatureGlobalID Performs a network source feature query for globalID by element ID.
Read-only property SourceFeatureOID Performs a network source feature query for OID by element ID.

IUtilityNetworkQuery.AllEIDs Property

Returns all network index EIDs.

Public Sub AllEIDs ( _
    ByRef EIDs As Int64[]&, _
    ByRef ElementTypes As Int32[]& _
)
public void AllEIDs (
    ref Int64[]& EIDs,
    ref Int32[]& ElementTypes
);

IUtilityNetworkQuery.AttributeByName Property

Returns the network attribute with the given name.

Public Function get_AttributeByName ( _
    ByVal Name As String _
) As IUtilityNetworkAttribute
public IUtilityNetworkAttribute get_AttributeByName (
    string Name
);

IUtilityNetworkQuery.AttributeValueByName Property

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

Public Function get_AttributeValueByName ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long, _
    ByVal AttributeName As String _
) As Object
public object get_AttributeValueByName (
    esriElementType ElementType,
    long EID,
    string AttributeName
);

IUtilityNetworkQuery.AttributeValueByUsageType Property

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

Public Function get_AttributeValueByUsageType ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long, _
    ByVal UsageType As esriUtilityNetworkAttributeUsageType _
) As Object
public object get_AttributeValueByUsageType (
    esriElementType ElementType,
    long EID,
    esriUtilityNetworkAttributeUsageType UsageType
);

IUtilityNetworkQuery.DirtyFeaturesOrObjects Property

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.

Public Sub DirtyFeaturesOrObjects ( _
    ByVal junctionEIDs As ILongLongArray, _
    ByVal edgeEIDs As ILongLongArray, _
    ByRef dirtyNetworkSourceIDs As ILongArray, _
    ByRef dirtyGlobalIDs As IStringArray _
)
public void DirtyFeaturesOrObjects (
    ILongLongArray junctionEIDs,
    ILongLongArray edgeEIDs,
    ref ILongArray dirtyNetworkSourceIDs,
    ref IStringArray dirtyGlobalIDs
);

IUtilityNetworkQuery.Elements Property

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

Public Sub Elements ( _
    ByVal GlobalID As Guid, _
    ByRef EIDs As Object, _
    ByRef ElementTypes As Object _
)
public void Elements (
    Guid GlobalID,
    ref object EIDs,
    ref object ElementTypes
);

IUtilityNetworkQuery.ElementsForSet Property

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

Public Sub ElementsForSet ( _
    ByVal GlobalIDs As String[], _
    ByRef EIDs As Object, _
    ByRef ElementTypes As Object _
)
public void ElementsForSet (
    String[] GlobalIDs,
    ref object EIDs,
    ref object ElementTypes
);

IUtilityNetworkQuery.FlowDirections Property

Returns the flow directions.

Public Sub FlowDirections ( _
    ByVal Extent As IEnvelope, _
    ByVal maxFlowDirectionCount As Integer, _
    ByRef arrows As IArray _
)
public void FlowDirections (
    IEnvelope Extent,
    int maxFlowDirectionCount,
    ref IArray arrows
);

IUtilityNetworkQuery.Geometry Property

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

Public Function get_Geometry ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long _
) As IGeometry
public IGeometry get_Geometry (
    esriElementType ElementType,
    long EID
);

IUtilityNetworkQuery.HasDirtyElement Property

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

Public Function get_HasDirtyElement ( _
    ByVal junctionEIDs As Int64[], _
    ByVal edgeEIDs As Int64[] _
) As Boolean
public bool get_HasDirtyElement (
    Int64[] junctionEIDs,
    Int64[] edgeEIDs
);

IUtilityNetworkQuery.IsSourceElementDirty Method

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

Public Function IsSourceElementDirty ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long _
) As Boolean
public bool IsSourceElementDirty (
    esriElementType ElementType,
    long EID
);

IUtilityNetworkQuery.IsSpatial Property

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

Public Function get_IsSpatial ( _
    ByVal NetworkSourceID As Integer _
) As Boolean
public bool get_IsSpatial (
    int NetworkSourceID
);

IUtilityNetworkQuery.IsTraversable Method

Indicates if the given network element is traversable.

Public Function IsTraversable ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long _
) As Boolean
public bool IsTraversable (
    esriElementType ElementType,
    long EID
);

IUtilityNetworkQuery.IsValidEID Method

Returns whether the specified element is part of the network.

Public Function IsValidEID ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long _
) As Boolean
public bool IsValidEID (
    esriElementType ElementType,
    long EID
);

IUtilityNetworkQuery.QueryAdjacentEdgesJunctions Method

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

Public Sub QueryAdjacentEdgesJunctions ( _
    ByVal junctionEID As Long, _
    ByRef adjacentEdges As Object, _
    ByRef adjacentJunctions As Object _
)
public void QueryAdjacentEdgesJunctions (
    long junctionEID,
    ref object adjacentEdges,
    ref object adjacentJunctions
);

IUtilityNetworkQuery.QueryAdjacentEdgesJunctionsWithWeights Method

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

Public Sub QueryAdjacentEdgesJunctionsWithWeights ( _
    ByVal junctionEID As Long, _
    ByVal traversabilityBased As Boolean, _
    ByRef adjacentEdges As Object, _
    ByRef adjacentJunctions As Object, _
    ByRef currentJunctionWeightIDs As ILongLongArray, _
    ByRef currentJunctionWeightValues As IVariantArray, _
    ByRef junctionConnectivityStatus As esriJunctionConnectivityStatus, _
    ByRef edgeWeightIDs As IArray, _
    ByRef edgeWeightValues As IArray _
)
public void QueryAdjacentEdgesJunctionsWithWeights (
    long junctionEID,
    bool traversabilityBased,
    ref object adjacentEdges,
    ref object adjacentJunctions,
    ref ILongLongArray currentJunctionWeightIDs,
    ref IVariantArray currentJunctionWeightValues,
    ref esriJunctionConnectivityStatus junctionConnectivityStatus,
    ref IArray edgeWeightIDs,
    ref IArray edgeWeightValues
);

IUtilityNetworkQuery.QueryFromToJunctions Method

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

Public Sub QueryFromToJunctions ( _
    ByVal edgeEID As Long, _
    ByRef FromJunctionEID As Int64&, _
    ByRef ToJunctionEID As Int64& _
)
public void QueryFromToJunctions (
    long edgeEID,
    ref Int64& FromJunctionEID,
    ref Int64& ToJunctionEID
);

IUtilityNetworkQuery.QueryGeometries Method

Query geometries for the given network elements.

Public Function QueryGeometries ( _
    ByVal ElementType As esriElementType, _
    ByVal EIDs As ILongLongArray, _
    ByVal overridePositionFroms As IDoubleArray, _
    ByVal overridePositionTos As IDoubleArray _
) As IArray
public IArray QueryGeometries (
    esriElementType ElementType,
    ILongLongArray EIDs,
    IDoubleArray overridePositionFroms,
    IDoubleArray overridePositionTos
);

IUtilityNetworkQuery.QueryJunctionConnectivityStatus Method

Returns the junction connectivity status.

Public Sub QueryJunctionConnectivityStatus ( _
    ByVal junctionEID As Long, _
    ByRef junctionConnectivityStatus As esriJunctionConnectivityStatus _
)
public void QueryJunctionConnectivityStatus (
    long junctionEID,
    ref esriJunctionConnectivityStatus junctionConnectivityStatus
);

IUtilityNetworkQuery.SourceFeatureGlobalID Property

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

Public Sub SourceFeatureGlobalID ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long, _
    ByRef SourceID As Integer, _
    ByRef GlobalID As Guid& _
)
public void SourceFeatureGlobalID (
    esriElementType ElementType,
    long EID,
    ref int SourceID,
    ref Guid& GlobalID
);

IUtilityNetworkQuery.SourceFeatureOID Property

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

Public Sub SourceFeatureOID ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long, _
    ByRef SourceID As Integer, _
    ByRef ObjectID As Integer _
)
public void SourceFeatureOID (
    esriElementType ElementType,
    long EID,
    ref int SourceID,
    ref int ObjectID
);

Classes that implement IUtilityNetworkQuery

Classes Description

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.