Module com.esri.arcgisruntime
Class UtilityTraceFunction
java.lang.Object
com.esri.arcgisruntime.utilitynetworks.UtilityTraceFunction
Functions allow the computation of values during a network trace.
Functions are evaluated at each applicable network element. The meaning of applicable varies depending on the Tracer.
For an upstream trace, the functions are evaluated for each upstream element. For a downstream trace, the functions
are evaluated for each element in the subnetwork, and so on.
 Since:
 100.7.0

Constructor Summary
ConstructorDescriptionUtilityTraceFunction
(UtilityTraceFunctionType functionType, UtilityNetworkAttribute networkAttribute) Creates a function to compute a value from a network attribute.UtilityTraceFunction
(UtilityTraceFunctionType functionType, UtilityNetworkAttribute networkAttribute, UtilityTraceCondition condition) Creates a function object to compute a value from a network attribute. 
Method Summary
Modifier and TypeMethodDescriptionGets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.Gets the calculation to perform.Gets theUtilityNetworkAttribute
to use with the calculation.void
setCondition
(UtilityTraceCondition condition) Sets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.

Constructor Details

UtilityTraceFunction
public UtilityTraceFunction(UtilityTraceFunctionType functionType, UtilityNetworkAttribute networkAttribute) Creates a function to compute a value from a network attribute. Parameters:
functionType
 the calculation to performnetworkAttribute
 theUtilityNetworkAttribute
to use with the calculation Throws:
IllegalArgumentException
 if functionType is nullIllegalArgumentException
 if networkAttribute is null Since:
 100.7.0

UtilityTraceFunction
public UtilityTraceFunction(UtilityTraceFunctionType functionType, UtilityNetworkAttribute networkAttribute, UtilityTraceCondition condition) Creates a function object to compute a value from a network attribute. Parameters:
functionType
 the calculation to performnetworkAttribute
 theUtilityNetworkAttribute
to use with the calculationcondition
 aUtilityTraceCondition
to use to restrict the functional calculation to features that satisfy the condition Throws:
IllegalArgumentException
 if functionType is nullIllegalArgumentException
 if networkAttribute is nullIllegalArgumentException
 if condition is null Since:
 100.9.0


Method Details

getFunctionType
Gets the calculation to perform. Returns:
 the calculation to perform
 Since:
 100.7.0

getNetworkAttribute
Gets theUtilityNetworkAttribute
to use with the calculation. Returns:
 the utility network attribute to use with the calculation
 Since:
 100.7.0

getCondition
Gets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition. Returns:
 the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition
 Since:
 100.9.0

setCondition
Sets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition. Parameters:
condition
 the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition, or null if none Since:
 100.9.0
