Limits the associations displayed based upon the associated feature's role or function. More...
| Header: | #include <UtilityAssociationsFilter.h> |
| Since: | Esri::ArcGISRuntime 200.7 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| UtilityAssociationsFilter(Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType, QObject *parent = nullptr) | |
| UtilityAssociationsFilter(Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType, Esri::ArcGISRuntime::UtilityAssetGroup *assetGroup, QObject *parent = nullptr) | |
| UtilityAssociationsFilter(Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType, Esri::ArcGISRuntime::UtilityAssetType *assetType, QObject *parent = nullptr) | |
| UtilityAssociationsFilter(Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType, Esri::ArcGISRuntime::UtilityNetworkSource *networkSource, QObject *parent = nullptr) | |
| virtual | ~UtilityAssociationsFilter() override |
| Esri::ArcGISRuntime::UtilityAssetGroup * | assetGroup() const |
| Esri::ArcGISRuntime::UtilityAssetType * | assetType() const |
| QString | description() const |
| Esri::ArcGISRuntime::UtilityAssociationsFilterType | filterType() const |
| Esri::ArcGISRuntime::UtilityNetworkSource * | networkSource() const |
| void | setDescription(const QString &description) |
| void | setTitle(const QString &title) |
| QString | title() const |
Detailed Description
Member Function Documentation
[explicit] UtilityAssociationsFilter::UtilityAssociationsFilter (Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType , QObject *parent = nullptr)
Creates a new utility network associations filter with the specified filter type.
- filterType - The type of filter to apply to the associations.
- parent - The optional parent QObject.
UtilityAssociationsFilter::UtilityAssociationsFilter (Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType , Esri::ArcGISRuntime::UtilityAssetGroup *assetGroup , QObject *parent = nullptr)
Creates a new utility network associations filter with the specified filter type and asset group.
- filterType - The type of filter to apply to the associations.
- assetGroup - The asset group to filter the associations by.
- parent - The optional parent QObject.
UtilityAssociationsFilter::UtilityAssociationsFilter (Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType , Esri::ArcGISRuntime::UtilityAssetType *assetType , QObject *parent = nullptr)
Creates a new utility network associations filter with the specified filter type and asset type.
- filterType - The type of filter to apply to the associations.
- assetType - The asset type to filter the associations by.
- parent - The optional parent QObject.
UtilityAssociationsFilter::UtilityAssociationsFilter (Esri::ArcGISRuntime::UtilityAssociationsFilterType filterType , Esri::ArcGISRuntime::UtilityNetworkSource *networkSource , QObject *parent = nullptr)
Creates a new utility network associations filter with the specified filter type and network source.
- filterType - The type of filter to apply to the associations.
- networkSource - The network source to filter the associations by.
- parent - The optional parent QObject.
[override virtual noexcept] UtilityAssociationsFilter::~UtilityAssociationsFilter ()
Destructor.
Esri::ArcGISRuntime::UtilityAssetGroup *UtilityAssociationsFilter::assetGroup () const
Returns filter the utility network associations by the asset group of the associated feature.
If the UtilityAssociationsFilter is part of a UtilityAssociationsPopupElement and the associations are filtered by UtilityAssetGroup, this property is populated when the UtilityNetwork is loaded. The Popup::evaluateExpressionsAsync method will load the UtilityNetwork.
See also Popup::evaluateExpressionsAsync.
Esri::ArcGISRuntime::UtilityAssetType *UtilityAssociationsFilter::assetType () const
Returns filter the utility network associations by the asset type of the associated feature.
If the UtilityAssociationsFilter is part of a UtilityAssociationsPopupElement and the associations are filtered by UtilityAssetType, this property is populated when the UtilityNetwork is loaded. The Popup::evaluateExpressionsAsync method will load the UtilityNetwork.
See also Popup::evaluateExpressionsAsync.
QString UtilityAssociationsFilter::description() const
Returns a string that describes the associations matching the filter criteria.
See also setDescription().
Esri::ArcGISRuntime::UtilityAssociationsFilterType UtilityAssociationsFilter::filterType () const
Returns filter the utility network associations by the associated feature's role or function.
Esri::ArcGISRuntime::UtilityNetworkSource *UtilityAssociationsFilter::networkSource () const
Returns filter the utility network associations by network source of the associated feature.
If the UtilityAssociationsFilter is part of a UtilityAssociationsPopupElement and the associations are filtered by UtilityNetworkSource, this property is populated when the UtilityNetwork is loaded. The Popup::evaluateExpressionsAsync method will load the UtilityNetwork.
See also Popup::evaluateExpressionsAsync.
void UtilityAssociationsFilter::setDescription (const QString &description)
Sets the description to description.
See also description.
void UtilityAssociationsFilter::setTitle (const QString &title)
Sets the title to title.
See also title.
QString UtilityAssociationsFilter::title() const
Returns a string title for the associated feature matching the filter criteria.
See also setTitle().