Interface IUtilityNetworkQueryDefinition

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

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

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("C8B8BCD5-0F60-4A6C-A374-E62CEEA3A686")]
public interface IUtilityNetworkQueryDefinition

Properties

FeatureClassUsageType[esriElementType, int]

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

esriUtilityNetworkFeatureClassUsageType FeatureClassUsageType[esriElementType ElementType, int SourceID] { get; }

Parameters

ElementType esriElementType
SourceID int

Property Value

esriUtilityNetworkFeatureClassUsageType

Remarks

The ElementType is no longer needed. However, a null value should be passed as of this parameter.

IsAttributeAssignedToSource[string, int]

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

bool IsAttributeAssignedToSource[string AttributeName, int SourceID] { get; }

Parameters

AttributeName string
SourceID int

Property Value

bool

IsInCategory[esriElementType, long, string]

Returns whether the specified element is in the specified category.

bool IsInCategory[esriElementType ElementType, long EID, string Category] { get; }

Parameters

ElementType esriElementType
EID long
Category string

Property Value

bool

IsUpstreamTerminal[esriElementType, long]

Returns whether the given element is an upstream terminal.

bool IsUpstreamTerminal[esriElementType ElementType, long EID] { get; }

Parameters

ElementType esriElementType
EID long

Property Value

bool

SourceElementTier[esriElementType, long]

Returns the tier for the given source element.

ITier SourceElementTier[esriElementType ElementType, long EID] { get; }

Parameters

ElementType esriElementType
EID long

Property Value

ITier

Remarks

The EID passed in must be a controller. The corresponding source ID, global ID, and terminal ID for the controller are then retrieved. Using the global ID and terminal ID the subnetworks table is queried for any matching record. The matching record will have a tier name. Using source ID we can get the relevant domain network and using tier name we can get the relevant tier within that domain network.

 This method doesn’t consider whether the subnetwork is clean (we allow tracing subnetworks that are not clean). No trace is executed in this method.

SupportCategory[int, int, int, string]

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

bool SupportCategory[int NetworkSourceID, int AssetGroupCode, int AssetTypeCode, string Category] { get; }

Parameters

NetworkSourceID int
AssetGroupCode int
AssetTypeCode int
Category string

Property Value

bool

Methods

AssetGroupCode(esriElementType, long, out int)

Returns the asset group code by EID.

void AssetGroupCode(esriElementType ElementType, long EID, out int AssetGroupCode)

Parameters

ElementType esriElementType
EID long
AssetGroupCode int

AssetTypeCode(esriElementType, long, out int)

Returns the asset type code by EID.

void AssetTypeCode(esriElementType ElementType, long EID, out int AssetTypeCode)

Parameters

ElementType esriElementType
EID long
AssetTypeCode int

CheckIfInternalEdge(long)

Check if an edge is internal or not.

bool CheckIfInternalEdge(long edgeEID)

Parameters

edgeEID long

Returns

bool

NetworkSourceID(esriElementType, long, out int)

Returns the source ID by EID.

void NetworkSourceID(esriElementType ElementType, long EID, out int NetworkSourceID)

Parameters

ElementType esriElementType
EID long
NetworkSourceID int

SubnetworkControllerByGlobalID(Guid, out string, out int, out string, out string, out int)

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

void SubnetworkControllerByGlobalID(Guid featureGlobalID, out string subnetworkControllerName, out int tierRank, out string featureAssetGroup, out string featureAssetType, out int featureSourceID)

Parameters

featureGlobalID Guid
subnetworkControllerName string
tierRank int
featureAssetGroup string
featureAssetType string
featureSourceID int

SubnetworkControllerByName(string, out int, out Guid, out string, out string, out int)

Returns the subnetwork controller with the given subnetwork controller name.

void SubnetworkControllerByName(string Name, out int tierRank, out Guid featureGlobalID, out string featureAssetGroup, out string featureAssetType, out int featureSourceID)

Parameters

Name string
tierRank int
featureGlobalID Guid
featureAssetGroup string
featureAssetType string
featureSourceID int

SubnetworkControllers(out object, out object, out object, out object)

Returns all subnetwork controllers.

void SubnetworkControllers(out object featureSourceIDs, out object featureGlobalIDs, out object subnetworkControllerNames, out object creationDates)

Parameters

featureSourceIDs object
featureGlobalIDs object
subnetworkControllerNames object
creationDates object

SubnetworkControllersBySubnetworkName(string, out IStringArray, out ILongArray)

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.

void SubnetworkControllersBySubnetworkName(string SubnetworkName, out IStringArray featureGlobalIDs, out ILongArray featureTerminalIDs)

Parameters

SubnetworkName string
featureGlobalIDs IStringArray
featureTerminalIDs ILongArray

SubnetworkNames(ILongLongArray, out IStringArray)

Returns subnetwork names for the given subnetwork controller elements.

void SubnetworkNames(ILongLongArray subnetworkControllerEIDs, out IStringArray SubnetworkNames)

Parameters

subnetworkControllerEIDs ILongLongArray
SubnetworkNames IStringArray

TerminalID(long, out int)

Returns the terminal ID by junction EID.

void TerminalID(long EID, out int TerminalID)

Parameters

EID long
TerminalID int

TerminalInfo(int, int, int, int, out bool, out esriUtilityNetworkTraversabilityModel, out int)

Returns the terminal info for the given element.

void TerminalInfo(int NetworkSourceID, int AssetGroupCode, int AssetTypeCode, int TerminalID, out bool IsUpstreamTerminal, out esriUtilityNetworkTraversabilityModel TraversabilityModel, out int TerminalCount)

Parameters

NetworkSourceID int
AssetGroupCode int
AssetTypeCode int
TerminalID int
IsUpstreamTerminal bool
TraversabilityModel esriUtilityNetworkTraversabilityModel
TerminalCount int

TierNames(ILongLongArray, out IStringArray)

Returns tier names for the given subnetwork source elements.

void TierNames(ILongLongArray subnetworkSourceEIDs, out IStringArray TierNames)

Parameters

subnetworkSourceEIDs ILongLongArray
TierNames IStringArray