Class 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
    • Method Detail

      • getFunctionType

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

        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

        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