Package com.esri.arcgisruntime.utilitynetworks

Class UtilityTraceFunction

java.lang.Object

com.esri.arcgisruntime.utilitynetworks.UtilityTraceFunction

public final class UtilityTraceFunction
extends java.lang.Object

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

Constructors

Constructor	Description
UtilityTraceFunction(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 Type	Method	Description
UtilityTraceCondition	getCondition()	Gets the UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.
UtilityTraceFunctionType	getFunctionType()	Gets the calculation to perform.
UtilityNetworkAttribute	getNetworkAttribute()	Gets the UtilityNetworkAttribute 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UtilityTraceFunction

public UtilityTraceFunction(UtilityTraceFunctionType functionType,
                            UtilityNetworkAttribute networkAttribute)

Creates a function to compute a value from a network attribute.

Parameters:

functionType - the calculation to perform

networkAttribute - the UtilityNetworkAttribute to use with the calculation

Throws:

java.lang.IllegalArgumentException - if functionType is null

java.lang.IllegalArgumentException - 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 perform

networkAttribute - the UtilityNetworkAttribute to use with the calculation

condition - a UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition

Throws:

java.lang.IllegalArgumentException - if functionType is null

java.lang.IllegalArgumentException - if networkAttribute is null

java.lang.IllegalArgumentException - if condition is null

Since:

100.9.0

Method Detail

getFunctionType

public UtilityTraceFunctionType getFunctionType()

Gets the calculation to perform.

Returns:

the calculation to perform

Since:

100.7.0

getNetworkAttribute

public UtilityNetworkAttribute getNetworkAttribute()

Gets the UtilityNetworkAttribute to use with the calculation.

Returns:

the utility network attribute to use with the calculation

Since:

100.7.0

getCondition

public UtilityTraceCondition 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

public void setCondition(UtilityTraceCondition condition)

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