Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.utilitynetworks

Enum Class UtilityTraceType

java.lang.Object
java.lang.Enum<UtilityTraceType>
com.esri.arcgisruntime.utilitynetworks.UtilityTraceType
All Implemented Interfaces:
Serializable, Comparable<UtilityTraceType>, Constable
public enum UtilityTraceType extends Enum<UtilityTraceType>
Defines a utility network's different trace types.
Since:
100.6.0

  • Enum Constant Details

    • 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 Details

    • values

      public static UtilityTraceType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static UtilityTraceType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null