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
ElementTypeesriElementTypeSourceIDint
Property Value
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
Property Value
IsInCategory[esriElementType, long, string]
Returns whether the specified element is in the specified category.
bool IsInCategory[esriElementType ElementType, long EID, string Category] { get; }
Parameters
ElementTypeesriElementTypeEIDlongCategorystring
Property Value
IsUpstreamTerminal[esriElementType, long]
Returns whether the given element is an upstream terminal.
bool IsUpstreamTerminal[esriElementType ElementType, long EID] { get; }
Parameters
ElementTypeesriElementTypeEIDlong
Property Value
SourceElementTier[esriElementType, long]
Returns the tier for the given source element.
ITier SourceElementTier[esriElementType ElementType, long EID] { get; }
Parameters
ElementTypeesriElementTypeEIDlong
Property Value
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.
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
Property Value
Methods
AssetGroupCode(esriElementType, long, out int)
Returns the asset group code by EID.
void AssetGroupCode(esriElementType ElementType, long EID, out int AssetGroupCode)
Parameters
ElementTypeesriElementTypeEIDlongAssetGroupCodeint
AssetTypeCode(esriElementType, long, out int)
Returns the asset type code by EID.
void AssetTypeCode(esriElementType ElementType, long EID, out int AssetTypeCode)
Parameters
ElementTypeesriElementTypeEIDlongAssetTypeCodeint
CheckIfInternalEdge(long)
Check if an edge is internal or not.
bool CheckIfInternalEdge(long edgeEID)
Parameters
edgeEIDlong
Returns
NetworkSourceID(esriElementType, long, out int)
Returns the source ID by EID.
void NetworkSourceID(esriElementType ElementType, long EID, out int NetworkSourceID)
Parameters
ElementTypeesriElementTypeEIDlongNetworkSourceIDint
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
featureGlobalIDGuidsubnetworkControllerNamestringtierRankintfeatureAssetGroupstringfeatureAssetTypestringfeatureSourceIDint
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
NamestringtierRankintfeatureGlobalIDGuidfeatureAssetGroupstringfeatureAssetTypestringfeatureSourceIDint
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
featureSourceIDsobjectfeatureGlobalIDsobjectsubnetworkControllerNamesobjectcreationDatesobject
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
SubnetworkNamestringfeatureGlobalIDsIStringArrayfeatureTerminalIDsILongArray
SubnetworkNames(ILongLongArray, out IStringArray)
Returns subnetwork names for the given subnetwork controller elements.
void SubnetworkNames(ILongLongArray subnetworkControllerEIDs, out IStringArray SubnetworkNames)
Parameters
subnetworkControllerEIDsILongLongArraySubnetworkNamesIStringArray
TerminalID(long, out int)
Returns the terminal ID by junction EID.
void TerminalID(long EID, out int TerminalID)
Parameters
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
NetworkSourceIDintAssetGroupCodeintAssetTypeCodeintTerminalIDintIsUpstreamTerminalboolTraversabilityModelesriUtilityNetworkTraversabilityModelTerminalCountint
TierNames(ILongLongArray, out IStringArray)
Returns tier names for the given subnetwork source elements.
void TierNames(ILongLongArray subnetworkSourceEIDs, out IStringArray TierNames)
Parameters
subnetworkSourceEIDsILongLongArrayTierNamesIStringArray