Class UtilityTraceFunctionBarrier
- java.lang.Object
-
- com.esri.arcgisruntime.utilitynetworks.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 aUtilityTraceFunction
and a given value. Remember that aUtilityTraceFunction
references aUtilityNetworkAttribute
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 Summary
Constructors Constructor Description UtilityTraceFunctionBarrier(UtilityTraceFunction traceFunction, UtilityAttributeComparisonOperator comparisonOperator, java.lang.Object value)
Creates a barrier that stops tracing when aUtilityTraceFunction
compared to a value evaluates to true.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UtilityAttributeComparisonOperator
getComparisonOperator()
Gets the operator used for the comparison.UtilityTraceFunction
getTraceFunction()
Gets the calculation to perform.java.lang.Object
getValue()
Gets the value to compare against.
-
-
-
Constructor Detail
-
UtilityTraceFunctionBarrier
public UtilityTraceFunctionBarrier(UtilityTraceFunction traceFunction, UtilityAttributeComparisonOperator comparisonOperator, java.lang.Object value)
Creates a barrier that stops tracing when aUtilityTraceFunction
compared to a value evaluates to true.- Parameters:
traceFunction
- the calculation to performcomparisonOperator
- the operator used for the comparisonvalue
- the value to compare against. The type of this numeric value is dependent on theUtilityNetworkAttribute.DataType
inUtilityNetworkAttribute
.- Throws:
java.lang.IllegalArgumentException
- if traceFunction is nulljava.lang.IllegalArgumentException
- if comparisonOperator is nulljava.lang.IllegalArgumentException
- if value is nulljava.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
-
getValue
public java.lang.Object getValue()
Gets the value to compare against.The type of this numeric value is dependent on the
UtilityNetworkAttribute.DataType
of theUtilityNetworkAttribute
.- Returns:
- the value to compare against
- Since:
- 100.7.0
-
-