Module com.esri.arcgisruntime
Class UtilityTraversability
java.lang.Object
com.esri.arcgisruntime.utilitynetworks.UtilityTraversability
A set of options controlling what objects are evaluated or returned during a tracing operation.
UtilityTraversability
is set in the UtilityTraceConfiguration
.- Since:
- 100.7.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets aUtilityTraceCondition
object specifying when to traverse a node or its subnodes.Gets a mutable list ofUtilityTraceFunctionBarrier
objects.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.
-
Constructor Details
-
UtilityTraversability
public UtilityTraversability()Create a new instance of UtilityTraversability.- Since:
- 100.7.0
-
-
Method Details
-
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
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:
IllegalArgumentException
- if traversabilityScope is null- Since:
- 100.7.0
-
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
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
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
-