UtilityTraceFunctionBarrierListModel Class

  • UtilityTraceFunctionBarrierListModel
  • class Esri::ArcGISRuntime::UtilityTraceFunctionBarrierListModel

    A container class storing a list of UtilityTraceFunctionBarrier objects. More...

    Header: #include <UtilityTraceFunctionBarrierListModel.h>
    Since: Esri::ArcGISRuntime 100.7
    Inherits: QAbstractListModel and Esri::ArcGISRuntime::Iterable

    This class was introduced in Esri::ArcGISRuntime 100.7.

    Public Types

    enum UtilityTraceFunctionBarrierRoles { UtilityTraceFunctionBarrierComparisonOperator, UtilityTraceFunctionBarrierValue }

    Public Functions

    virtual ~UtilityTraceFunctionBarrierListModel() override
    void append(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier)
    void clear()
    bool contains(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier) const
    Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *first() const
    int indexOf(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier) const
    void insert(int index, Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier)
    bool isEmpty() const
    Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *last() const
    void move(int from, int to)
    void removeAt(int index)
    void removeOne(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier)

    Reimplemented Public Functions

    virtual Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *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(Esri::ArcGISRuntime::Error error)
    void itemAdded(int index)
    void itemRemoved(int index)

    Detailed Description

    The model returns data for the following roles:

    RoleTypeDescriptionUtilityTraceFunctionBarrierRoles
    comparisonOperatorUtilityAttributeComparisonOperatorThe operator used for the comparison.UtilityAttributeComparisonOperator
    valueQVariantThe value to compare againstUtilityTraceFunctionBarrierValue

    See also UtilityTraceFunctionBarrier.

    Member Type Documentation

    enum UtilityTraceFunctionBarrierListModel::UtilityTraceFunctionBarrierRoles

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

    ConstantValueDescription
    Esri::ArcGISRuntime::UtilityTraceFunctionBarrierListModel::UtilityTraceFunctionBarrierComparisonOperatorQt::UserRole + 1The operator used for the comparison.
    Esri::ArcGISRuntime::UtilityTraceFunctionBarrierListModel::UtilityTraceFunctionBarrierValueQt::UserRole + 2The value to compare against.

    Member Function Documentation

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

    Signal emitted when an error occurs.

    • error - Details about the error.

    [signal] void UtilityTraceFunctionBarrierListModel::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] void UtilityTraceFunctionBarrierListModel::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.

    [override virtual] UtilityTraceFunctionBarrierListModel::~UtilityTraceFunctionBarrierListModel()

    Destructor.

    void UtilityTraceFunctionBarrierListModel::append(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier)

    Appends the utilityTraceFunctionBarrier to the list model.

    [override virtual] Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *UtilityTraceFunctionBarrierListModel::at(int index) const

    Returns the UtilityTraceFunctionBarrier at the specified index.

    void UtilityTraceFunctionBarrierListModel::clear()

    Removes all UtilityTraceFunctionBarrier instances 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 UtilityTraceFunctionBarrierListModel::contains(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier) const

    Returns whether the provided utilityTraceFunctionBarrier is in the list model.

    [override virtual] QVariant UtilityTraceFunctionBarrierListModel::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 UtilityTraceFunctionBarrier referred to by the index.

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

    Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *UtilityTraceFunctionBarrierListModel::first() const

    Returns the first UtilityTraceFunctionBarrier in the list model.

    int UtilityTraceFunctionBarrierListModel::indexOf(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier) const

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

    void UtilityTraceFunctionBarrierListModel::insert(int index, Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier)

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

    bool UtilityTraceFunctionBarrierListModel::isEmpty() const

    Returns true if this list model is empty.

    Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *UtilityTraceFunctionBarrierListModel::last() const

    Returns the last UtilityTraceFunctionBarrier in the list model.

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

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

    void UtilityTraceFunctionBarrierListModel::removeAt(int index)

    Removes a UtilityTraceFunctionBarrier 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 UtilityTraceFunctionBarrierListModel::removeOne(Esri::ArcGISRuntime::UtilityTraceFunctionBarrier *utilityTraceFunctionBarrier)

    Removes the specified utilityTraceFunctionBarrier 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 UtilityTraceFunctionBarrierListModel::size() const

    Returns the number of trace function barriers in the model.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.