ArcGIS Developers
Dashboard

UtilityTraceFunctionListModel QML Type

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

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

Properties

Signals

Methods

  • void append(UtilityTraceFunction utilityTraceFunction)
  • void clear()
  • bool contains(UtilityTraceFunction utilityTraceFunction)
  • void forEach(callback)
  • UtilityTraceFunction get(int index)
  • int indexOf(UtilityTraceFunction utilityTraceFunction)
  • void insert(int index, UtilityTraceFunction utilityTraceFunction)
  • void move(int from, int to)
  • void remove(int index, int count)
  • void removeOne(UtilityTraceFunction utilityTraceFunction)
  • 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
propagatorFunctionTypeUtilityTraceFunctionFunctionTypeThe 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 UtilityTraceFunction.

Property Documentation

count : int

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


Signal Documentation

countChanged()

Emitted when the count property of the model changes.

Note: The corresponding handler is onCountChanged.


utilityTraceFunctionAdded(int index)

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

Note: The corresponding handler is onUtilityTraceFunctionAdded.


utilityTraceFunctionRemoved(int index)

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

Note: The corresponding handler is onUtilityTraceFunctionRemoved.


Method Documentation

void append(UtilityTraceFunction utilityTraceFunction)

Appends a utilityTraceFunction to the UtilityTraceFunction list model.


void clear()

Removes all utility propagators from the list model.


bool contains(UtilityTraceFunction utilityTraceFunction)

Returns true if the list model contains the specified utilityTraceFunction.


void forEach(callback)

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

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

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

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

UtilityTraceFunction get(int index)

Returns the utility propagator at the specified index.


int indexOf(UtilityTraceFunction utilityTraceFunction)

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


void insert(int index, UtilityTraceFunction utilityTraceFunction)

Inserts a utilityTraceFunction 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(UtilityTraceFunction utilityTraceFunction)

Removes the specified utilityTraceFunction from the list model.


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

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



Feedback on this topic?