Class UtilityTraceFunction

java.lang.Object
com.esri.arcgisruntime.utilitynetworks.UtilityTraceFunction

public final class UtilityTraceFunction extends Object
Functions allow the computation of values during a network trace. Functions are evaluated at each applicable network element. The meaning of applicable varies depending on the Tracer. For an upstream trace, the functions are evaluated for each upstream element. For a downstream trace, the functions are evaluated for each element in the subnetwork, and so on.
Since:
100.7.0
  • Constructor Details Link icon

  • Method Details Link icon

    • getFunctionType Link icon

      public UtilityTraceFunctionType getFunctionType()
      Gets the calculation to perform.
      Returns:
      the calculation to perform
      Since:
      100.7.0
    • getNetworkAttribute Link icon

      public UtilityNetworkAttribute getNetworkAttribute()
      Gets the UtilityNetworkAttribute to use with the calculation.
      Returns:
      the utility network attribute to use with the calculation
      Since:
      100.7.0
    • getCondition Link icon

      public UtilityTraceCondition getCondition()
      Gets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.
      Returns:
      the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition
      Since:
      100.9.0
    • setCondition Link icon

      public void setCondition(UtilityTraceCondition condition)
      Sets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.
      Parameters:
      condition - the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition, or null if none
      Since:
      100.9.0