Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityPropagatorListModel Class

(Esri::ArcGISRuntime::UtilityPropagatorListModel)

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

Header: #include <UtilityPropagatorListModel>
Since: Esri::ArcGISRuntime 100.7
Inherits: QAbstractListModel and Iterable<UtilityPropagator *>

Public Types

enum UtilityPropagatorRoles { UtilityPropagatorComparisonOperator, UtilityPropagatorNetworkAttribute, UtilityPropagatorPropagatorFunctionType, UtilityPropagatorSubstitutionNetworkAttribute, UtilityPropagatorValue }

Public Functions

~UtilityPropagatorListModel()
void append(UtilityPropagator *utilityPropagator)
UtilityPropagator *at(int index) const
void clear()
bool contains(UtilityPropagator *utilityPropagator) const
UtilityPropagator *first() const
int indexOf(UtilityPropagator *utilityPropagator) const
void insert(int index, UtilityPropagator *utilityPropagator)
bool isEmpty() const
UtilityPropagator *last() const
void move(int from, int to)
void removeAt(int index)
void removeOne(UtilityPropagator *utilityPropagator)
int size() const

Reimplemented Public Functions

virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const

Signals

void errorOccurred(Esri::ArcGISRuntime::Error error)
void utilityPropagatorAdded(int index)
void utilityPropagatorRemoved(int index)

Additional Inherited Members

Detailed Description

A container class storing a list of UtilityPropagators.

The model returns data for the following roles:

RoleTypeDescriptionUtilityPropagatorRoles
comparisonOperatorUtilityAttributeComparisonOperatorThe operator that is applied when executing the trace.UtilityAttributeComparisonOperator
networkAttributeUtilityNetworkAttribute*TThe UtilityNetworkAttribute to propagate further along the traceUtilityPropagatorNetworkAttribute
propagatorFunctionTypeUtilityPropagatorFunctionTypeThe function type that is applied to the UtilityNetworkAttributeUtilityPropagatorPropagatorFunctionType
substitutionNetworkAttributeUtilityNetworkAttribute*The UtilityNetworkAttribute that maps each bit in another bitsetUtilityPropagatorSubstitutionNetworkAttribute
valueQVariantThe value that is compared against the propagated value when executing the trace.UtilityPropagatorValue

See also UtilityPropagator.

Member Type Documentation

enum UtilityPropagatorListModel::UtilityPropagatorRoles

This enum specifies the custom roles which can be used with UtilityPropagatorListModel::data.

ConstantValueDescription
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorComparisonOperatorQt::UserRole + 1The operator that is applied when executing the trace.
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorNetworkAttributeQt::UserRole + 2The UtilityNetworkAttribute to propagate further along the trace
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorPropagatorFunctionTypeQt::UserRole + 3The function type that is applied to the UtilityNetworkAttribute
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorSubstitutionNetworkAttributeQt::UserRole + 4The UtilityNetworkAttribute that maps each bit in another bitset
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorValueQt::UserRole + 5The value that is compared against the propagated value when executing the trace.

Member Function Documentation

UtilityPropagatorListModel::~UtilityPropagatorListModel()

Destructor.

void UtilityPropagatorListModel::append(UtilityPropagator *utilityPropagator)

Appends the utilityPropagator to the utility propagator list model.

UtilityPropagator *UtilityPropagatorListModel::at(int index) const

Returns the utility propagator at the specified index.

void UtilityPropagatorListModel::clear()

Removes all utility propagators from the list model.

bool UtilityPropagatorListModel::contains(UtilityPropagator *utilityPropagator) const

Returns whether the provided utilityPropagator is in the list model.

[virtual] QVariant UtilityPropagatorListModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const

Reimplemented from QAbstractItemModel::data().

Returns the data stored under the given role for the utility propagator referred to by the index.

  • index - The index in the model for which to return data.
  • role - The role for which to return data.

[signal] void UtilityPropagatorListModel::errorOccurred(Esri::ArcGISRuntime::Error error)

Signal emitted when an error occurs.

  • error - Details about the error.

UtilityPropagator *UtilityPropagatorListModel::first() const

Returns the first utility propagator in the list model.

int UtilityPropagatorListModel::indexOf(UtilityPropagator *utilityPropagator) const

Returns the index of the provided utilityPropagator in the list model.

void UtilityPropagatorListModel::insert(int index, UtilityPropagator *utilityPropagator)

Inserts a utilityPropagator at a specified index in the list model.

bool UtilityPropagatorListModel::isEmpty() const

Returns true if this list model is empty.

UtilityPropagator *UtilityPropagatorListModel::last() const

Returns the last utility propagator in the list model.

void UtilityPropagatorListModel::move(int from, int to)

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

void UtilityPropagatorListModel::removeAt(int index)

Removes a utility propagator at the specified index in the list model.

void UtilityPropagatorListModel::removeOne(UtilityPropagator *utilityPropagator)

Removes the specified utilityPropagator from the list model.

int UtilityPropagatorListModel::size() const

Returns the number of utility propagators in the model.

[signal] void UtilityPropagatorListModel::utilityPropagatorAdded(int index)

Signal emitted when a UtilityPropagator is added to the list.

index is the index of the added UtilityPropagator.

[signal] void UtilityPropagatorListModel::utilityPropagatorRemoved(int index)

Signal emitted when a UtilityPropagator is removed from the list.

index is the index of the removed UtilityPropagator.


Feedback on this topic?