UtilityRule Class

  • UtilityRule
  • class Esri::ArcGISRuntime::UtilityRule

    Defines a permissible association between features in a utility network. More...

    Header: #include <UtilityRule.h>
    Since: Esri::ArcGISRuntime 200.1
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~UtilityRule() override
    Esri::ArcGISRuntime::UtilityRuleElement *fromElement() const
    qint64 ruleId() const
    Esri::ArcGISRuntime::UtilityRuleType ruleType() const
    Esri::ArcGISRuntime::UtilityRuleElement *toElement() const
    Esri::ArcGISRuntime::UtilityRuleElement *viaElement() const

    Detailed Description

    Network rules help maintain data integrity. They are imposed at the asset group, asset type, and terminal levels for the entire utility network to manage the correctness of assets in the network by allowing you to select which types of features can be connected or associated. A network rule supporting the type of association between features must exist or these features cannot be associated.

    Member Function Documentation

    [override virtual] UtilityRule::~UtilityRule()

    Destructor.

    Esri::ArcGISRuntime::UtilityRuleElement *UtilityRule::fromElement() const

    Returns the first participant in a network rule.

    This may describe a container or structure feature, or any feature from which a connection to another feature can be made.

    qint64 UtilityRule::ruleId() const

    Returns the ID of this network rule.

    Esri::ArcGISRuntime::UtilityRuleType UtilityRule::ruleType() const

    Returns the UtilityRuleType of this network rule.

    Esri::ArcGISRuntime::UtilityRuleElement *UtilityRule::toElement() const

    Returns the second participant in a network rule.

    This may describe a content or attachment feature, a container feature in a nested containment, or any feature from which a connection to another feature can be made.

    Esri::ArcGISRuntime::UtilityRuleElement *UtilityRule::viaElement() const

    Returns an optional intermediate participant in a network rule.

    This is available only in a UtilityRuleType::EdgeJunctionEdgeConnectivity network rule and is commonly used to describe a junction feature without a terminal.

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