UtilityTerminal Class

  • UtilityTerminal
  • class Esri::ArcGISRuntime::UtilityTerminal

    A single terminal on a junction feature. More...

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

    Public Functions

    virtual ~UtilityTerminal() override
    bool isUpstreamTerminal() const
    QString name() const
    int terminalId() const

    Detailed Description

    Terminal objects can be obtained from UtilityTerminalConfiguration::terminals().

    Relevant samples:

    • Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
    • 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.
    • Perform valve isolation trace: Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.
    • Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.

    Member Function Documentation

    [override virtual] UtilityTerminal::~UtilityTerminal()

    Destructor.

    [since Esri::ArcGISRuntime 100.8] bool UtilityTerminal::isUpstreamTerminal() const

    Returns whether this terminal is on the upstream side of the device.

    In source-based networks, upstream is towards the subnetwork controller. In sink-based networks, upstream is away from the subnetwork controller.

    This function was introduced in Esri::ArcGISRuntime 100.8.

    QString UtilityTerminal::name() const

    Returns the name of the utility terminal.

    int UtilityTerminal::terminalId() const

    Returns the ID of the utility terminal.

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

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close