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

Class UtilityTraceParameters

java.lang.Object
com.esri.arcgisruntime.utilitynetworks.UtilityTraceParameters
public final class UtilityTraceParameters extends Object
Defines the configuration of particular trace parameters in a Utility Network.
Since:
100.6.0

  • Constructor Details

  • Method Details

    • getBarriers

      public List<UtilityElement> getBarriers()
      Gets a mutable list of barriers. Initially it is empty. Add UtilityElement to it to specify barriers.
      Returns:
      a mutable list of UtilityElements that specify the barriers
      Since:
      100.6.0

    • getFilterBarriers

      public List<UtilityElement> getFilterBarriers()
      Gets the collection of filter barriers.

      A regular barrier, specified by getBarriers(), prevents traversal which, when used with subnetwork-based traces, can prevent traversal to the subnetwork controller. Like UtilityTraceConfiguration.getFilter(), filter barriers are evaluated in the second pass of a trace. Therefore, it can restrict the result set without impacting the ability to find subnetwork controllers from starting points.

      One example of where filter barriers can be used is in the gas distribution domain. Filter barriers can be used to simulate the location of a squeeze-off when executing a valve isolation trace. The user can place a filter barrier at the proposed location of the squeeze-off and then verify its impact using a trace.

      Returns:
      a mutable list of filter barriers
      Since:
      100.10.0

    • getResultTypes

      public List<UtilityTraceResult.Type> getResultTypes()
      Gets a mutable list of trace parameters' result types.

      The list is pre-populated with the default of UtilityTraceResult.Type.ELEMENTS. This list corresponds to the UtilityTraceResult list returned by UtilityNetwork.traceAsync(UtilityTraceParameters).

      Returns:
      a mutable list of result types
      Since:
      100.6.0

    • getStartingLocations

      public List<UtilityElement> getStartingLocations()
      Gets a mutable list of trace parameters' starting locations. Initially it is empty. Add UtilityElement to it to specify starting locations. A starting point is set of network features to define the location in the network where a trace begins. All utility network traces require that one or more starting points are defined.
      Returns:
      a mutable list of UtilityElements that specify the starting locations
      Since:
      100.6.0

    • getTraceType

      public UtilityTraceType getTraceType()
      Gets the trace parameters' trace type.
      Returns:
      the trace type
      Since:
      100.6.0

    • getTraceConfiguration

      public UtilityTraceConfiguration getTraceConfiguration()
      Gets the complete collection of trace options.
      Returns:
      the complete collection of trace options or null if none (for example when using a straight connected trace)
      Since:
      100.7.0

    • setTraceConfiguration

      public void setTraceConfiguration(UtilityTraceConfiguration utilityTraceConfiguration)
      Sets the complete collection of trace options.
      Parameters:
      utilityTraceConfiguration - the new value for trace configuration or null if none (for example when using a straight connected trace)
      Since:
      100.7.0