Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityPropagatorListModel QML Type

A container class storing a list of UtilityPropagators. More...

Import Statement: import Esri.ArcGISRuntime 100.8
Since: Esri.ArcGISRuntime 100.7

Properties

Signals

Methods

  • void append(UtilityPropagator utilityPropagator)
  • void clear()
  • bool contains(UtilityPropagator utilityPropagator)
  • void forEach(callback )
  • UtilityPropagator get(int index)
  • int indexOf(UtilityPropagator UtilityPropagator)
  • void insert(int index, UtilityPropagator UtilityPropagator)
  • void move(int from, int to)
  • void remove(int index, int count)
  • void removeOne(UtilityPropagator UtilityPropagator)
  • void setProperty(int index, string property, variant value)

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

The model returns data for the following roles:

RoleTypeDescription
comparisonOperatorUtilityAttributeComparisonOperatorThe operator that is applied when executing the trace.
networkAttributeUtilityNetworkAttributeTThe UtilityNetworkAttribute to propagate further along the trace
propagatorFunctionTypeUtilityPropagatorFunctionTypeThe function type that is applied to the UtilityNetworkAttribute
substitutionNetworkAttributeUtilityNetworkAttributeThe UtilityNetworkAttribute that maps each bit in another bitset
valueQVariantThe value that is compared against the propagated value when executing the trace.

See also UtilityPropagator.

Property Documentation

count : int

Returns the number of objects in the model (read-only).


Signal Documentation

UtilityPropagatorAdded(int index)

Emitted when an object is added to the list model at the index specified in the parameter.


UtilityPropagatorRemoved(int index)

Emitted when an object is removed from the list model at the index specified in the parameter.


countChanged()

Emitted when the count property of the model changes.


Method Documentation

void append(UtilityPropagator utilityPropagator)

Appends a utilityPropagator to the UtilityPropagator list model.


void clear()

Removes all utility propagators from the list model.


bool contains(UtilityPropagator utilityPropagator)

Returns true if the list model contains the specified utilityPropagator.


void forEach(callback )

Receives a callback function to execute for each utility propagator in the model.

The callback function can take 0 to 3 optional arguments, in order:

Returns undefined if no error occurred, and an error message otherwise.

var error = UtilityPropagatorListModel.forEach(function(element, index, array) {
    ...
});
if (error) {
    console.error(error.message);
}

UtilityPropagator get(int index) const

Returns the utility propagator at the specified index.


int indexOf(UtilityPropagator UtilityPropagator)

Returns the index of a specific utilityPropagator from the list model.


void insert(int index, UtilityPropagator UtilityPropagator)

Inserts a utilityPropagator at a specified index in the list.


void move(int from, int to)

Moves one utility propagator from an index in the list model to a different index.


void remove(int index, int count = 1)

Removes one or more objects starting at the specified index.

  • index Index of first object to remove.
  • count Number of objects to remove. This parameter defaults to 1.

void removeOne(UtilityPropagator UtilityPropagator)

Removes the specified utilityPropagator from the list model.


void setProperty(int index, string property, variant value)

Changes the property of the UtilityPropagator at index in the list model to value.



Feedback on this topic?