AGSUtilityNetworkAttribute Class Reference

Description

A network attribute in a utility network.

A network attribute is an attribute that is copied and stored in the topological index. The utility network tracing task can read and make decisions using network attributes that are stored directly in the topological index. Without needing to fetch the individual features to get their attributes, the topological index provides performance that is orders of magnitude faster.

The network attributes in a topological index are limited to specific data types and aggregate size.

Since

100.6

Inheritance diagram for AGSUtilityNetworkAttribute:

Properties
BOOL	apportionable
AGSUtilityNetworkAttributeDataType	dataType
AGSDomain *	domain
NSString *	name
AGSUtilityNetworkAttribute *	networkAttributeToSubstitute
BOOL	substitution
BOOL	systemDefined

Property Documentation

apportionable

- (BOOL) apportionable

readnonatomicassign

Whether the network attribute should be apportioned across the length of linear features. For example, if a point is chosen, 25% of the distance along an edge, 25% of the attribute's value is assigned to the 25% (shorter) part of the edge, and 75% of the attribute's value is assigned to the 75% (longer) part of the edge.

Since

100.7

dataType

- (AGSUtilityNetworkAttributeDataType) dataType

readnonatomicassign

The AGSUtilityNetworkAttributeDataType object for the AGSUtilityNetworkAttribute object. The network attributes in a topological index are limited to specific data types.

Since

100.6

domain

- (AGSDomain*) domain

readnonatomicstrong

The AGSDomain object associated with this network attribute. If no domain is assigned, nil is returned.

Since

100.7

name

- (NSString*) name

readnonatomiccopy

The name of the AGSUtilityNetworkAttribute object.

Since

100.6

networkAttributeToSubstitute

- (AGSUtilityNetworkAttribute*) networkAttributeToSubstitute

readnonatomicstrong

The AGSUtilityNetworkAttribute object that is substituted for this AGSUtilityNetworkAttribute object at tap features. This property is only set if AGSUtilityNetworkAttribute::substitution property is set to YES. Taps are special features, identified with the "Subnetwork Tap" category, that work with attribute substitution. See the online help for more information.

Since

100.7

substitution

- (BOOL) substitution

readnonatomicassign

Whether the AGSUtilityNetworkAttribute object is used as a substitution for another network attribute at tap features. If this value is YES, this network attribute is the network attribute to substitute for the AGSUtilityNetworkAttribute::networkAttributeToSubstitute property at tap features. Taps are special features, identified with the "Subnetwork Tap" category, that work with attribute substitution. See the online help for more information.

Since

100.7

systemDefined

- (BOOL) systemDefined

readnonatomicassign

Indicates that the network attribute has been added by the system.

Since

100.7