Module com.esri.arcgisruntime
Class UtilityTraceFunctionBarrier
java.lang.Object
com.esri.arcgisruntime.utilitynetworks.UtilityTraceFunctionBarrier
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 Summary
ConstructorDescriptionUtilityTraceFunctionBarrier
(UtilityTraceFunction traceFunction, UtilityAttributeComparisonOperator comparisonOperator, Object value) Creates a barrier that stops tracing when aUtilityTraceFunction
compared to a value evaluates to true. -
Method Summary
Modifier and TypeMethodDescriptionGets the operator used for the comparison.Gets the calculation to perform.getValue()
Gets the value to compare against.
-
Constructor Details
-
UtilityTraceFunctionBarrier
public UtilityTraceFunctionBarrier(UtilityTraceFunction traceFunction, UtilityAttributeComparisonOperator comparisonOperator, 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:
IllegalArgumentException
- if traceFunction is nullIllegalArgumentException
- if comparisonOperator is nullIllegalArgumentException
- if value is nullIllegalArgumentException
- if value is not a valid network attribute datatype- Since:
- 100.7.0
-
-
Method Details
-
getTraceFunction
Gets the calculation to perform.- Returns:
- the calculation to perform
- Since:
- 100.7.0
-
getComparisonOperator
Gets the operator used for the comparison.- Returns:
- the operator used for the comparison
- Since:
- 100.7.0
-
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
-