A container class storing a list of UtilityPropagators. More...
| Header: | #include <UtilityPropagatorListModel.h> |
| Since: | Esri::ArcGISRuntime 100.7 |
| Inherits: | QAbstractListModel and Esri::ArcGISRuntime::Iterable |
Public Types
| enum | UtilityPropagatorRoles { UtilityPropagatorComparisonOperator, UtilityPropagatorNetworkAttribute, UtilityPropagatorPropagatorFunctionType, UtilityPropagatorSubstitutionNetworkAttribute, UtilityPropagatorValue } |
Public Functions
| virtual | ~UtilityPropagatorListModel() override |
| void | append(Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator) |
| void | clear() |
| bool | contains(Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator) const |
| Esri::ArcGISRuntime::UtilityPropagator * | first() const |
| int | indexOf(Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator) const |
| void | insert(int index, Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator) |
| bool | isEmpty() const |
| Esri::ArcGISRuntime::UtilityPropagator * | last() const |
| void | move(int from, int to) |
| void | removeAt(int index) |
| void | removeOne(Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator) |
Reimplemented Public Functions
| virtual Esri::ArcGISRuntime::UtilityPropagator * | at(int index) const override |
| virtual QVariant | data(const QModelIndex &index, int role = Qt::DisplayRole) const override |
| virtual int | size() const override |
Signals
| void | errorOccurred(const Esri::ArcGISRuntime::Error &error) |
| void | itemAdded(int index) |
| void | itemRemoved(int index) |
Detailed Description
The model returns data for the following roles:
| Role | Type | Description | UtilityPropagatorRoles |
|---|---|---|---|
| comparisonOperator | UtilityAttributeComparisonOperator | The operator that is applied when executing the trace. | UtilityAttributeComparisonOperator |
| networkAttribute | UtilityNetworkAttribute* | The UtilityNetworkAttribute to propagate further along the trace | UtilityPropagatorNetworkAttribute |
| propagatorFunctionType | UtilityPropagatorFunctionType | The function type that is applied to the UtilityNetworkAttribute | UtilityPropagatorPropagatorFunctionType |
| substitutionNetworkAttribute | UtilityNetworkAttribute* | The UtilityNetworkAttribute that maps each bit in another bitset | UtilityPropagatorSubstitutionNetworkAttribute |
| value | QVariant | The 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.
| Constant | Value | Description |
|---|---|---|
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorComparisonOperator | Qt::UserRole + 1 | The operator that is applied when executing the trace. |
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorNetworkAttribute | Qt::UserRole + 2 | The UtilityNetworkAttribute to propagate further along the trace |
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorPropagatorFunctionType | Qt::UserRole + 3 | The function type that is applied to the UtilityNetworkAttribute |
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorSubstitutionNetworkAttribute | Qt::UserRole + 4 | The UtilityNetworkAttribute that maps each bit in another bitset |
Esri::ArcGISRuntime::UtilityPropagatorListModel::UtilityPropagatorValue | Qt::UserRole + 5 | The value that is compared against the propagated value when executing the trace. |
Member Function Documentation
[override virtual] UtilityPropagatorListModel::~UtilityPropagatorListModel ()
Destructor.
void UtilityPropagatorListModel::append(Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator )
Appends the utilityPropagator to the utility propagator list model.
[override virtual] Esri::ArcGISRuntime::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.
List models do not take ownership of the objects they contain. Therefore, removing or clearing objects from the list model will not delete those objects. An RAII technique should be used to ensure that memory is properly deallocated.
bool UtilityPropagatorListModel::contains(Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator ) const
Returns whether the provided utilityPropagator is in the list model.
[override virtual] QVariant UtilityPropagatorListModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const
Reimplements: QAbstractItemModel::data(const QModelIndex &index, int role) const.
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 (const Esri::ArcGISRuntime::Error &error)
Signal emitted when an error occurs.
- error - Details about the error.
Esri::ArcGISRuntime::UtilityPropagator *UtilityPropagatorListModel::first() const
Returns the first utility propagator in the list model.
int UtilityPropagatorListModel::indexOf (Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator ) const
Returns the index of the provided utilityPropagator in the list model.
void UtilityPropagatorListModel::insert(int index, Esri::ArcGISRuntime::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.
[signal, since Esri::ArcGISRuntime 100.15] void UtilityPropagatorListModel::itemAdded (int index)
Signal emitted when an item is added to the list.
index is the index of the added item.
This function was introduced in Esri::ArcGISRuntime 100.15.
[signal, since Esri::ArcGISRuntime 100.15] void UtilityPropagatorListModel::itemRemoved (int index)
Signal emitted when an item is removed from the list.
index is the index of the removed item.
This function was introduced in Esri::ArcGISRuntime 100.15.
Esri::ArcGISRuntime::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.
List models do not take ownership of the objects they contain. Therefore, removing or clearing objects from the list model will not delete those objects. An RAII technique should be used to ensure that memory is properly deallocated.
void UtilityPropagatorListModel::removeOne (Esri::ArcGISRuntime::UtilityPropagator *utilityPropagator )
Removes the specified utilityPropagator from the list model.
List models do not take ownership of the objects they contain. Therefore, removing or clearing objects from the list model will not delete those objects. An RAII technique should be used to ensure that memory is properly deallocated.
[override virtual] int UtilityPropagatorListModel::size() const
Returns the number of utility propagators in the model.