Class UtilityTraceFunctionBarrier


  • public final class UtilityTraceFunctionBarrier
    extends java.lang.Object
    A UtilityTraceFunctionBarrier stops continued traversal when a comparison expression evaluates as true. A UtilityTraceFunctionBarrier performs a comparison expression between the current results of a UtilityTraceFunction and a given value. Remember that a UtilityTraceFunction references a UtilityNetworkAttribute and a calculation that is applied to it (Min, Max, Count, and so on). Once the comparison evaluates as true, network traversal stops.
    Since:
    100.7.0
    • Constructor Detail

      • UtilityTraceFunctionBarrier

        public UtilityTraceFunctionBarrier​(UtilityTraceFunction traceFunction,
                                           UtilityAttributeComparisonOperator comparisonOperator,
                                           java.lang.Object value)
        Creates a barrier that stops tracing when a UtilityTraceFunction compared to a value evaluates to true.
        Parameters:
        traceFunction - the calculation to perform
        comparisonOperator - the operator used for the comparison
        value - the value to compare against. The type of this numeric value is dependent on the UtilityNetworkAttribute.DataType in UtilityNetworkAttribute.
        Throws:
        java.lang.IllegalArgumentException - if traceFunction is null
        java.lang.IllegalArgumentException - if comparisonOperator is null
        java.lang.IllegalArgumentException - if value is null
        java.lang.IllegalArgumentException - if value is not a valid network attribute datatype
        Since:
        100.7.0
    • Method Detail

      • getTraceFunction

        public UtilityTraceFunction getTraceFunction()
        Gets the calculation to perform.
        Returns:
        the calculation to perform
        Since:
        100.7.0
      • getComparisonOperator

        public UtilityAttributeComparisonOperator getComparisonOperator()
        Gets the operator used for the comparison.
        Returns:
        the operator used for the comparison
        Since:
        100.7.0