UtilityNetworkAttributeComparison Class

  • UtilityNetworkAttributeComparison
  • class Esri::ArcGISRuntime::UtilityNetworkAttributeComparison

    A condition evaluating the value of a UtilityNetworkAttribute on nodes in the network, either to another UtilityNetworkAttribute or to a specific value. More...

    Header: #include <UtilityNetworkAttributeComparison.h>
    Since: Esri::ArcGISRuntime 100.7
    Inherits: Esri::ArcGISRuntime::UtilityTraceConditionalExpression

    Public Functions

    UtilityNetworkAttributeComparison(Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute, Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator, const QVariant &value, QObject *parent = nullptr)
    UtilityNetworkAttributeComparison(Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute, Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator, Esri::ArcGISRuntime::UtilityNetworkAttribute *otherNetworkAttribute, QObject *parent = nullptr)
    virtual ~UtilityNetworkAttributeComparison() override
    Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator() const
    Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute() const
    Esri::ArcGISRuntime::UtilityNetworkAttribute *otherNetworkAttribute() const
    QVariant value() const

    Detailed Description

    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.

    Member Function Documentation

    UtilityNetworkAttributeComparison::UtilityNetworkAttributeComparison(Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute, Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator, const QVariant &value, QObject *parent = nullptr)

    Creates a condition comparing a UtilityNetworkAttribute to a specific value.

    Note: The UtilityNetworkAttribute::dataType of networkAttribute and value must match.

    • networkAttribute - The source UtilityNetworkAttribute that the value is compared to
    • comparisonOperator - The type of comparison to do between the source UtilityNetworkAttribute and the value
    • value - The specific value to compare networkAttribute against for each node in the trace. The value can be an integer data type, which can contain a small or large integer, or it can be double data type, which can contain a double or a date.
    • parent - The optional parent QObject.

    UtilityNetworkAttributeComparison::UtilityNetworkAttributeComparison(Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute, Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator, Esri::ArcGISRuntime::UtilityNetworkAttribute *otherNetworkAttribute, QObject *parent = nullptr)

    Creates a condition comparing the value of one UtilityNetworkAttribute to another.

    Note: The UtilityNetworkAttribute::dataType of networkAttribute and otherNetworkAttribute must match.

    [override virtual] UtilityNetworkAttributeComparison::~UtilityNetworkAttributeComparison()

    Destructor.

    Esri::ArcGISRuntime::UtilityAttributeComparisonOperator UtilityNetworkAttributeComparison::comparisonOperator() const

    Returns the type of comparison to do between the source UtilityNetworkAttribute and either the second UtilityNetworkAttribute or the value.

    Esri::ArcGISRuntime::UtilityNetworkAttribute *UtilityNetworkAttributeComparison::networkAttribute() const

    Returns the source UtilityNetworkAttribute that otherNetworkAttribute or value is compared to.

    Esri::ArcGISRuntime::UtilityNetworkAttribute *UtilityNetworkAttributeComparison::otherNetworkAttribute() const

    Returns the UtilityNetworkAttribute being compared against UtilityNetworkAttributeComparison::networkAttribute on each of the nodes.

    This is null if the comparison is against a specific value.

    QVariant UtilityNetworkAttributeComparison::value() const

    Returns the specific value to compare networkAttribute against for each node in the trace.

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