Package com.esri.arcgisruntime.utilitynetworks

Class UtilityPropagator

java.lang.Object

com.esri.arcgisruntime.utilitynetworks.UtilityPropagator

public final class UtilityPropagator
extends java.lang.Object

Propagator objects allow a subset of UtilityNetworkAttribute values to propagate through a network while executing a trace.

The propagated UtilityNetworkAttribute values can be tested to allow or disallow further traversal. In the example of phase propagation, open devices along the network will restrict some phases from continuing along the trace. Propagators only apply to subnetwork-based traces (UtilityTraceType.UPSTREAM, UtilityTraceType.DOWNSTREAM and so on).

UtilityPropagator is set in the UtilityTraceConfiguration.

Since:

100.7.0

Constructor Summary

Constructors

Constructor	Description
UtilityPropagator(UtilityNetworkAttribute networkAttribute, UtilityPropagatorFunctionType propagatorFunctionType, UtilityAttributeComparisonOperator comparisonOperator, java.lang.Object value)	Creates a utility propagator object that allows a subset of UtilityNetworkAttribute values to propagate through a network.
UtilityPropagator(UtilityNetworkAttribute networkAttribute, UtilityPropagatorFunctionType propagatorFunctionType, UtilityAttributeComparisonOperator comparisonOperator, java.lang.Object value, UtilityNetworkAttribute substitutionAttribute)	Creates a utility propagator object that allows a subset of UtilityNetworkAttribute values to propagate through a network.

Method Summary

Modifier and Type	Method	Description
UtilityAttributeComparisonOperator	getComparisonOperator()	Gets the operator that is applied when executing the trace.
UtilityNetworkAttribute	getNetworkAttribute()	Gets the UtilityNetworkAttribute to propagate further along the trace.
UtilityPropagatorFunctionType	getPropagatorFunctionType()	Gets the function type that is applied to the UtilityNetworkAttribute to propagate the attribute further along the trace.
UtilityNetworkAttribute	getSubstitutionNetworkAttribute()	Gets the UtilityNetworkAttribute that maps each bit in another bitset network attribute value to a new value.
java.lang.Object	getValue()	Gets the value that is compared against the propagated value when executing the trace.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilityPropagator

public UtilityPropagator(UtilityNetworkAttribute networkAttribute,
                         UtilityPropagatorFunctionType propagatorFunctionType,
                         UtilityAttributeComparisonOperator comparisonOperator,
                         java.lang.Object value)

Creates a utility propagator object that allows a subset of UtilityNetworkAttribute values to propagate through a network.

Parameters:

networkAttribute - the network attribute to propagate further along the trace

propagatorFunctionType - the function type that is applied to the utility network attribute to propagate the attribute further along the trace

comparisonOperator - the filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified getValue().

value - the value that is compared against the propagated value when executing the trace. The type of this numeric value is dependent on UtilityNetworkAttribute.DataType in UtilityNetworkAttribute.

Throws:

java.lang.IllegalArgumentException - if networkAttribute is null

java.lang.IllegalArgumentException - if propagatorFunctionType is null

java.lang.IllegalArgumentException - if comparisonOperator is null

java.lang.IllegalArgumentException - if value is null

java.lang.IllegalArgumentException - if value is not a valid network attribute datatype

Since:

100.7.0

UtilityPropagator

public UtilityPropagator(UtilityNetworkAttribute networkAttribute,
                         UtilityPropagatorFunctionType propagatorFunctionType,
                         UtilityAttributeComparisonOperator comparisonOperator,
                         java.lang.Object value,
                         UtilityNetworkAttribute substitutionAttribute)

Creates a utility propagator object that allows a subset of UtilityNetworkAttribute values to propagate through a network.

Parameters:

networkAttribute - the network attribute to propagate further along the trace

propagatorFunctionType - the function type that is applied to the utility network attribute to propagate the attribute further along the trace

comparisonOperator - the filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified getValue().

value - the value that is compared against the propagated value when executing the trace. The type of this numeric value is dependent on the UtilityNetworkAttribute.DataType in UtilityNetworkAttribute.

substitutionAttribute - a utility network attribute that maps each bit in another bitset network attribute value to a new value

Throws:

java.lang.IllegalArgumentException - if networkAttribute is null

java.lang.IllegalArgumentException - if propagatorFunctionType is null

java.lang.IllegalArgumentException - if comparisonOperator is null

java.lang.IllegalArgumentException - if value is null

java.lang.IllegalArgumentException - if value is not a valid network attribute datatype

java.lang.IllegalArgumentException - if substitutionAttribution is null

Since:

100.7.0

Method Detail

getComparisonOperator

public UtilityAttributeComparisonOperator getComparisonOperator()

Gets the operator that is applied when executing the trace.

This operator is used to compare the propagated value to the specified getValue(). For example, if propagating phase, this would be UtilityAttributeComparisonOperator.INCLUDES_ANY.

Returns:

the operator applied when executing the trace

Since:

100.7.0

getNetworkAttribute

public UtilityNetworkAttribute getNetworkAttribute()

Gets the UtilityNetworkAttribute to propagate further along the trace.

For example, if propagating phase, this would be the UtilityNetworkAttribute that stores phase.

Returns:

the utility network attribute to propagate further along the trace

Since:

100.7.0

getPropagatorFunctionType

public UtilityPropagatorFunctionType getPropagatorFunctionType()

Gets the function type that is applied to the UtilityNetworkAttribute to propagate the attribute further along the trace.

For example, if propagating phase, this would be UtilityPropagatorFunctionType.BITWISE_AND.

Returns:

the function type

Since:

100.7.0

getSubstitutionNetworkAttribute

public UtilityNetworkAttribute getSubstitutionNetworkAttribute()

Gets the UtilityNetworkAttribute that maps each bit in another bitset network attribute value to a new value.

Returns:

the utility network attribute

Since:

100.7.0

getValue

public java.lang.Object getValue()

Gets the value that is compared against the propagated value when executing the trace.

The type of this numeric value is dependent on the UtilityNetworkAttribute.DataType of the UtilityNetworkAttribute.

Returns:

the value

Since:

100.7.0