IUtilityNetworkQueryDefinition Interface

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

Members

Name Description
Read-only property AssetGroupCode Returns the asset group code by EID.
Read-only property AssetTypeCode Returns the asset type code by EID.
Method CheckIfInternalEdge Check if an edge is internal or not.
Read-only property FeatureClassUsageType Returns the utility network feature class usage type for the source.
Read-only property IsAttributeAssignedToSource Returns whether the attribute has been assigned to the given source.
Read-only property IsInCategory Returns whether the specified element is in the specified category.
Read-only property IsUpstreamTerminal Returns whether the given element is an upstream terminal.
Read-only property NetworkSourceID Returns the source ID by EID.
Read-only property SourceElementTier Returns the tier for the given source element.
Read-only property SubnetworkControllerByGlobalID Returns the subnetwork controller with the given subnetwork controller global ID.
Read-only property SubnetworkControllerByName Returns the subnetwork controller with the given subnetwork controller name.
Read-only property SubnetworkControllers Returns all subnetwork controllers.
Read-only property SubnetworkControllersBySubnetworkName Returns the feature global IDs and feature terminal IDs in the subnetworks table that correspond to the given subnetwork name and have not been deleted.
Read-only property SubnetworkNames Returns subnetwork names for the given subnetwork controller elements.
Read-only property SupportCategory Returns whether the specified source-assetGroup-assetType combination is in the specified category.
Read-only property TerminalID Returns the terminal ID by junction EID.
Read-only property TerminalInfo Returns the terminal info for the given element.
Read-only property TierNames Returns tier names for the given subnetwork source elements.

IUtilityNetworkQueryDefinition.AssetGroupCode Property

Returns the asset group code by EID.

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

IUtilityNetworkQueryDefinition.AssetTypeCode Property

Returns the asset type code by EID.

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

IUtilityNetworkQueryDefinition.CheckIfInternalEdge Method

Check if an edge is internal or not.

Public Function CheckIfInternalEdge ( _
    ByVal edgeEID As Long _
) As Boolean
public bool CheckIfInternalEdge (
    long edgeEID
);

IUtilityNetworkQueryDefinition.FeatureClassUsageType Property

Returns the utility network feature class usage type for the source.

Public Function get_FeatureClassUsageType ( _
    ByVal ElementType As esriElementType, _
    ByVal SourceID As Integer _
) As esriUtilityNetworkFeatureClassUsageType
public esriUtilityNetworkFeatureClassUsageType get_FeatureClassUsageType (
    esriElementType ElementType,
    int SourceID
);

IUtilityNetworkQueryDefinition.IsAttributeAssignedToSource Property

Returns whether the attribute has been assigned to the given source.

Public Function get_IsAttributeAssignedToSource ( _
    ByVal AttributeName As String, _
    ByVal SourceID As Integer _
) As Boolean
public bool get_IsAttributeAssignedToSource (
    string AttributeName,
    int SourceID
);

IUtilityNetworkQueryDefinition.IsInCategory Property

Returns whether the specified element is in the specified category.

Public Function get_IsInCategory ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long, _
    ByVal Category As String _
) As Boolean
public bool get_IsInCategory (
    esriElementType ElementType,
    long EID,
    string Category
);

IUtilityNetworkQueryDefinition.IsUpstreamTerminal Property

Returns whether the given element is an upstream terminal.

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

IUtilityNetworkQueryDefinition.NetworkSourceID Property

Returns the source ID by EID.

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

IUtilityNetworkQueryDefinition.SourceElementTier Property

Returns the tier for the given source element.

Public Function get_SourceElementTier ( _
    ByVal ElementType As esriElementType, _
    ByVal EID As Long _
) As ITier
public ITier get_SourceElementTier (
    esriElementType ElementType,
    long EID
);

IUtilityNetworkQueryDefinition.SubnetworkControllerByGlobalID Property

Returns the subnetwork controller with the given subnetwork controller global ID.

Public Sub SubnetworkControllerByGlobalID ( _
    ByVal featureGlobalID As Guid, _
    ByRef subnetworkControllerName As String, _
    ByRef tierRank As Integer, _
    ByRef featureAssetGroup As String, _
    ByRef featureAssetType As String, _
    ByRef featureSourceID As Integer _
)
public void SubnetworkControllerByGlobalID (
    Guid featureGlobalID,
    ref string subnetworkControllerName,
    ref int tierRank,
    ref string featureAssetGroup,
    ref string featureAssetType,
    ref int featureSourceID
);

IUtilityNetworkQueryDefinition.SubnetworkControllerByName Property

Returns the subnetwork controller with the given subnetwork controller name.

Public Sub SubnetworkControllerByName ( _
    ByVal Name As String, _
    ByRef tierRank As Integer, _
    ByRef featureGlobalID As Guid&, _
    ByRef featureAssetGroup As String, _
    ByRef featureAssetType As String, _
    ByRef featureSourceID As Integer _
)
public void SubnetworkControllerByName (
    string Name,
    ref int tierRank,
    ref Guid& featureGlobalID,
    ref string featureAssetGroup,
    ref string featureAssetType,
    ref int featureSourceID
);

IUtilityNetworkQueryDefinition.SubnetworkControllers Property

Returns all subnetwork controllers.

Public Sub SubnetworkControllers ( _
    ByRef featureSourceIDs As Object, _
    ByRef featureGlobalIDs As Object, _
    ByRef subnetworkControllerNames As Object, _
    ByRef creationDates As Object _
)
public void SubnetworkControllers (
    ref object featureSourceIDs,
    ref object featureGlobalIDs,
    ref object subnetworkControllerNames,
    ref object creationDates
);

IUtilityNetworkQueryDefinition.SubnetworkControllersBySubnetworkName Property

Returns the feature global IDs and feature terminal IDs in the subnetworks table that correspond to the given subnetwork name and have not been deleted.

Public Sub SubnetworkControllersBySubnetworkName ( _
    ByVal SubnetworkName As String, _
    ByRef featureGlobalIDs As IStringArray, _
    ByRef featureTerminalIDs As ILongArray _
)
public void SubnetworkControllersBySubnetworkName (
    string SubnetworkName,
    ref IStringArray featureGlobalIDs,
    ref ILongArray featureTerminalIDs
);

IUtilityNetworkQueryDefinition.SubnetworkNames Property

Returns subnetwork names for the given subnetwork controller elements.

Public Sub SubnetworkNames ( _
    ByVal subnetworkControllerEIDs As ILongLongArray, _
    ByRef SubnetworkNames As IStringArray _
)
public void SubnetworkNames (
    ILongLongArray subnetworkControllerEIDs,
    ref IStringArray SubnetworkNames
);

IUtilityNetworkQueryDefinition.SupportCategory Property

Returns whether the specified source-assetGroup-assetType combination is in the specified category.

Public Function get_SupportCategory ( _
    ByVal NetworkSourceID As Integer, _
    ByVal AssetGroupCode As Integer, _
    ByVal AssetTypeCode As Integer, _
    ByVal Category As String _
) As Boolean
public bool get_SupportCategory (
    int NetworkSourceID,
    int AssetGroupCode,
    int AssetTypeCode,
    string Category
);

IUtilityNetworkQueryDefinition.TerminalID Property

Returns the terminal ID by junction EID.

Public Sub TerminalID ( _
    ByVal EID As Long, _
    ByRef TerminalID As Integer _
)
public void TerminalID (
    long EID,
    ref int TerminalID
);

IUtilityNetworkQueryDefinition.TerminalInfo Property

Returns the terminal info for the given element.

Public Sub TerminalInfo ( _
    ByVal NetworkSourceID As Integer, _
    ByVal AssetGroupCode As Integer, _
    ByVal AssetTypeCode As Integer, _
    ByVal TerminalID As Integer, _
    ByRef IsUpstreamTerminal As Boolean, _
    ByRef TraversabilityModel As esriUtilityNetworkTraversabilityModel, _
    ByRef TerminalCount As Integer _
)
public void TerminalInfo (
    int NetworkSourceID,
    int AssetGroupCode,
    int AssetTypeCode,
    int TerminalID,
    ref bool IsUpstreamTerminal,
    ref esriUtilityNetworkTraversabilityModel TraversabilityModel,
    ref int TerminalCount
);

IUtilityNetworkQueryDefinition.TierNames Property

Returns tier names for the given subnetwork source elements.

Public Sub TierNames ( _
    ByVal subnetworkSourceEIDs As ILongLongArray, _
    ByRef TierNames As IStringArray _
)
public void TierNames (
    ILongLongArray subnetworkSourceEIDs,
    ref IStringArray TierNames
);

Classes that implement IUtilityNetworkQueryDefinition

Classes Description

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