Class UtilityNetworkAttribute


  • public final class UtilityNetworkAttribute
    extends java.lang.Object
    Defines a network attribute in a utility network.
    Since:
    100.6.0
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the network attribute's name.
        Returns:
        the name of the network attribute
        Since:
        100.6.0
      • getDomain

        public Domain getDomain()
        Gets the Domain associated with this network attribute.
        Returns:
        the domain or null if no domain is assigned
        Since:
        100.7.0
      • isSubstitution

        public boolean isSubstitution()
        Indicates whether the UtilityNetworkAttribute is used as a substitution for another network attribute at tap features.

        If the value is true, this network attribute is the network attribute to substitute for getNetworkAttributeToSubstitute() 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.

        Returns:
        true if the utility network attribute is used as a substitution, false otherwise
        Since:
        100.7.0
      • isSystemDefined

        public boolean isSystemDefined()
        Indicates that the network attribute has been added by the system.
        Returns:
        true if the network attribute has been added by the system
        Since:
        100.7.0
      • getNetworkAttributeToSubstitute

        public UtilityNetworkAttribute getNetworkAttributeToSubstitute()
        Gets the UtilityNetworkAttribute that is substituted for this UtilityNetworkAttribute at tap features.

        This property is only set if isSubstitution() is set to true. Taps are special features, identified with the "Subnetwork Tap" category, that work with attribute substitution. See the online help for more information.

        Returns:
        the utility network attribute that is substituted or null if none
        Since:
        100.7.0
      • isApportionable

        public boolean isApportionable()
        Indicates 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.

        Returns:
        true if the network attribute should be apportioned across the length of linear features, false otherwise
        Since:
        100.7.0