ArcGIS Runtime SDK for iOS: AGSUtilityElement Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSUtilityElement Class Reference

Description

An entity in a utility network that corresponds to an AGSFeature object.

AGSUtilityElement includes a reference to an AGSFeature object inside a utility network source, plus a terminal (if applicable). AGSUtilityElement objects are used across the utility network API. Some places where they are used are to specify starting points and barriers for use with tracing, and returned as results from tracing.

Since
100.6
Inheritance diagram for AGSUtilityElement:
AGSObject

Properties

AGSUtilityAssetGroupassetGroup
 
AGSUtilityAssetTypeassetType
 
double fractionAlongEdge
 
NSUUID * globalID
 
AGSUtilityNetworkSourcenetworkSource
 
NSInteger objectID
 
AGSUtilityTerminalterminal
 
BOOL valid
 

Property Documentation

◆ assetGroup

- (AGSUtilityAssetGroup*) assetGroup
readnonatomicstrong

The asset group the element belongs to.

Since
100.6

◆ assetType

- (AGSUtilityAssetType*) assetType
readnonatomicstrong

The asset type the element belongs to.

Since
100.6

◆ fractionAlongEdge

- (double) fractionAlongEdge
readwritenonatomicassign

How far the starting point or barrier is located along an edge in the utility network feature, from 0.0 (edge's start) to 1.0 (edge's end) This property is only valid when the AGSUtilityElement::globalID property refers to an edge feature that is an input to a tracing operation.

Since
100.6

◆ globalID

- (NSUUID*) globalID
readnonatomicstrong

The global ID of the element.

Since
100.6

◆ networkSource

- (AGSUtilityNetworkSource*) networkSource
readnonatomicstrong

The AGSUtilityNetworkSource object the element is from.

Since
100.6

◆ objectID

- (NSInteger) objectID
readnonatomicassign

The object ID of the element's corresponding feature in the AGSUtilityElement::networkSource property. Only valid on results from a tracing operation, or with elements that are created from an AGSArcGISFeature. Otherwise the value -1 is returned.

Since
100.6

◆ terminal

- (AGSUtilityTerminal*) terminal
readwritenonatomicstrong

The AGSUtilityTerminal object of the utility network feature. Only valid when the AGSUtilityElement::globalID property refers to a device feature.

Since
100.6

◆ valid

- (BOOL) valid
readnonatomicassign

Indicates whether or not the AGSUtilityElement object has complete data available.

When taking an AGSUtilityNetwork object offline, some of the data can be filtered out to limit the size of the data. This may leave some elements in an incomplete state. For example, one element of an association may be included in the offline dataset while the other element may not.

When an element is incomplete, the following properties should not be used:

When AGSUtilityElement::valid is NO, the AGSUtilityAssetType::associationDeletionSemantics property is assumed to be AGSUtilityAssociationDeletionSemanticsRestricted.

Since
100.11