Class UtilityTraversability
- java.lang.Object
-
- com.esri.arcgisruntime.utilitynetworks.UtilityTraversability
-
public final class UtilityTraversability extends java.lang.Object
A set of options controlling what objects are evaluated or returned during a tracing operation.UtilityTraversability
is set in theUtilityTraceConfiguration
.- Since:
- 100.7.0
-
-
Constructor Summary
Constructors Constructor Description UtilityTraversability()
Create a new instance of UtilityTraversability.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UtilityTraceCondition
getBarriers()
Gets aUtilityTraceCondition
object specifying when to traverse a node or its subnodes.java.util.List<UtilityTraceFunctionBarrier>
getFunctionBarriers()
Gets a mutable list ofUtilityTraceFunctionBarrier
objects.UtilityTraversabilityScope
getScope()
Determines whether traversability criteria are evaluated on edges, junctions, or both.void
setBarriers(UtilityTraceCondition barriers)
Sets theUtilityTraceCondition
object specifying when to traverse a node or its subnodes.void
setScope(UtilityTraversabilityScope utilityTraversabilityScope)
Sets whether traversability criteria are evaluated on edges, junctions, or both.
-
-
-
Method Detail
-
getScope
public UtilityTraversabilityScope getScope()
Determines whether traversability criteria are evaluated on edges, junctions, or both.The default value is
UtilityTraversabilityScope.JUNCTIONS_AND_EDGES
.- Returns:
- determines whether traversability criteria are evaluated on edges, junctions, or both
- Since:
- 100.7.0
-
setScope
public void setScope(UtilityTraversabilityScope utilityTraversabilityScope)
Sets whether traversability criteria are evaluated on edges, junctions, or both.The default value is
UtilityTraversabilityScope.JUNCTIONS_AND_EDGES
.- Parameters:
utilityTraversabilityScope
- the traversability scope- Throws:
java.lang.IllegalArgumentException
- if traversabilityScope is null- Since:
- 100.7.0
-
getBarriers
public UtilityTraceCondition getBarriers()
Gets aUtilityTraceCondition
object specifying when to traverse a node or its subnodes.Used to specify the conditions under which a trace stops.
- Returns:
- the utility trace condition
- Since:
- 100.7.0
-
setBarriers
public void setBarriers(UtilityTraceCondition barriers)
Sets theUtilityTraceCondition
object specifying when to traverse a node or its subnodes.- Parameters:
barriers
- the new value for barriers or null if none- Since:
- 100.7.0
-
getFunctionBarriers
public java.util.List<UtilityTraceFunctionBarrier> getFunctionBarriers()
Gets a mutable list ofUtilityTraceFunctionBarrier
objects. If any of these objects evaluates to true, further traversal is terminated. Initially the list is empty.- Returns:
- a mutable list of
UtilityTraceFunctionBarrier
objects - Since:
- 100.7.0
-
-