UtilityNetworkSource Class

  • UtilityNetworkSource
  • class Esri::ArcGISRuntime::UtilityNetworkSource

    A network source in a utility network. More...

    Header: #include <UtilityNetworkSource.h>
    Since: Esri::ArcGISRuntime 100.6
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~UtilityNetworkSource() override
    Esri::ArcGISRuntime::UtilityAssetGroup *assetGroup(const QString &assetGroupName) const
    QList<Esri::ArcGISRuntime::UtilityAssetGroup *> assetGroups() const
    Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable() const
    QString name() const
    int sourceId() const
    Esri::ArcGISRuntime::UtilityNetworkSourceType sourceType() const
    Esri::ArcGISRuntime::UtilityNetworkSourceUsageType sourceUsageType() const

    Detailed Description

    Various sources of related information are associated to comprise the utility network. The most obvious sources are the structures and network features that are included with each domain network. Other sources are the set of associations and the system junctions.

    The UtilityNetworkDefinition::networkSources property contains the list of UtilityNetworkSource objects in the utility network definition.

    Relevant samples:

    • Create load report: Create a simple electric distribution report that displays the count of customers and total load per phase by tracing downstream from a given point.
    • Display utility associations: Create graphics for utility associations in a utility network.
    • Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.

    Member Function Documentation

    [override virtual] UtilityNetworkSource::~UtilityNetworkSource()

    Destructor.

    Esri::ArcGISRuntime::UtilityAssetGroup *UtilityNetworkSource::assetGroup(const QString &assetGroupName) const

    Returns an associated asset group by name.

    • assetGroupName - The name of the asset group

    Returns nullptr if there is no matching asset group.

    UtilityAssetGroup is the first-level categorization of a UtilityNetworkSource.

    QList<Esri::ArcGISRuntime::UtilityAssetGroup *> UtilityNetworkSource::assetGroups() const

    Returns a list of asset groups for the utility network source.

    UtilityAssetGroup is the first-level categorization of a UtilityNetworkSource.

    Esri::ArcGISRuntime::ArcGISFeatureTable *UtilityNetworkSource::featureTable() const

    Returns the ArcGISFeatureTable that corresponds to the UtilityNetworkSource.

    QString UtilityNetworkSource::name() const

    Returns the name of the UtilityNetworkSource.

    int UtilityNetworkSource::sourceId() const

    Returns the ID of the UtilityNetworkSource.

    Esri::ArcGISRuntime::UtilityNetworkSourceType UtilityNetworkSource::sourceType() const

    Returns the source type of the UtilityNetworkSource.

    Esri::ArcGISRuntime::UtilityNetworkSourceUsageType UtilityNetworkSource::sourceUsageType() const

    Returns the usage type of the UtilityNetworkSource.

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