Propagator Constructor(NetworkAttribute,PropagatorFunction,Operator,Double)

In This Topic

Initializes a new instance of the Propagator class.

Syntax

C#
Visual Basic (Declaration)

public Propagator( 
   NetworkAttribute networkAttribute,
   PropagatorFunction propagatorFunction,
   Operator comparisonOperator,
   double value
)

Public Function New( _
   ByVal networkAttribute As NetworkAttribute, _
   ByVal propagatorFunction As PropagatorFunction, _
   ByVal comparisonOperator As Operator, _
   ByVal value As Double _
)

Parameters

networkAttribute: The ArcGIS.Core.Data.UtilityNetwork.NetworkAttribute to propagate downstream from the source.
propagatorFunction: The function that is applied to the ArcGIS.Core.Data.UtilityNetwork.NetworkAttribute to propagate the attribute downstream.
comparisonOperator: The filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified Value.
value: The value that is compared against the propagated value when executing the trace.

Exceptions

Exception	Description
System.ArgumentNullException	networkAttribute is null.
System.ArgumentOutOfRangeException	propagatorFunction is not a field of PropagatorFunction. -or- comparisonOperator is not a field of Operator.
System.ArgumentException	value is invalid, e.g., it is not a number.

Exception

Description

System.ArgumentNullException

is null.

System.ArgumentOutOfRangeException

propagatorFunction is not a field of PropagatorFunction.

-or-

comparisonOperator is not a field of Operator.

System.ArgumentException

is invalid, e.g., it is not a number.

Example

Create a Propagator

// Get a NetworkAttribute object for the Phases Normal attribute from the UtilityNetworkDefinition
using (NetworkAttribute normalPhaseAttribute = utilityNetworkDefinition.GetNetworkAttribute("Phases Normal"))
{
  // Create a propagator to propagate the Phases Normal attribute downstream from the source, using a Bitwise And function
  // Allow traversal to continue as long as the Phases Normal value includes any of the ABC phases
  // (represented by the constant ABCPhase)
  Propagator phasePropagator = new Propagator(normalPhaseAttribute, PropagatorFunction.BitwiseAnd, Operator.IncludesAny, ABCPhase);

  // Assign this propagator to our trace configuration
  traceConfiguration.Propagators = new List<Propagator>() { phasePropagator };
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Propagator Class
Propagator Members
Overload List

Send feedback