Package com.esri.arcgisruntime.utilitynetworks

Enum UtilityTraceType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<UtilityTraceType>
    public enum UtilityTraceType
extends java.lang.Enum<UtilityTraceType>
    Defines a utility network's different trace types.
    Since:
    100.6.0

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static UtilityTraceType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static UtilityTraceType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • CONNECTED

        public static final UtilityTraceType CONNECTED
        Connected trace.

        Finds all features connected to a given set of starting points, ignoring traversability.

        Since:
        100.6.0

      • SUBNETWORK

        public static final UtilityTraceType SUBNETWORK
        Subnetwork trace.

        Finds all features within the current subnetwork.

        Since:
        100.7.0

      • UPSTREAM

        public static final UtilityTraceType UPSTREAM
        Upstream trace.

        For subnetworks with sources, upstream is defined as paths that lead to a source. For subnetworks with sinks, upstream is defined as paths that do not lead to a sink.

        Since:
        100.7.0

      • DOWNSTREAM

        public static final UtilityTraceType DOWNSTREAM
        Downstream trace.

        For subnetworks with sources, downstream is defined as paths that do not lead to a source. For subnetworks with sinks, downstream is defined as paths that lead to a sink.

        Since:
        100.7.0

      • ISOLATION

        public static final UtilityTraceType ISOLATION
        Isolation trace.

        The isolation trace requires that at least one UtilityTraceFilter barrier is set in the UtilityTraceConfiguration. Typically this filter identifies those features that isolate the section of network (e.g. valves).

        Since:
        100.8.0

      • LOOPS

        public static final UtilityTraceType LOOPS
        Detects loops in the network.

        The loops trace finds areas of the network where flow direction is ambiguous where resource can flow in either direction. Loops are expected with mesh networks but usually indicate error conditions in radial networks.

        Since:
        100.9.0

      • SHORTEST_PATH

        public static final UtilityTraceType SHORTEST_PATH
        Discovers the shortest path.

        This trace returns the shortest path based on cost or distance, which is calculated using a numeric network attribute such as shape length.

        Since:
        100.9.0

    • Method Detail

      • values

        public static UtilityTraceType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (UtilityTraceType c : UtilityTraceType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static UtilityTraceType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null