A logical barrier that stops continued network traversal when a comparison expression evaluates as true. More...
| Header: | #include <UtilityTraceFunctionBarrier.h> |
| Since: | Esri::ArcGISRuntime 100.7 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| UtilityTraceFunctionBarrier(Esri::ArcGISRuntime::UtilityTraceFunction *traceFunction, Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator, const QVariant &value, QObject *parent = nullptr) | |
| virtual | ~UtilityTraceFunctionBarrier() override |
| Esri::ArcGISRuntime::UtilityAttributeComparisonOperator | comparisonOperator() const |
| Esri::ArcGISRuntime::UtilityTraceFunction * | traceFunction() const |
| QVariant | value() const |
Detailed Description
A UtilityTraceFunctionBarrier performs a comparison expression between the current results of a UtilityTraceFunction and a given value. A UtilityTraceFunction references a UtilityNetworkAttribute and a calculation that is applied to it (Min, Max, Count, and so on). Once the comparison evaluates as true, network traversal stops.
Member Function Documentation
UtilityTraceFunctionBarrier::UtilityTraceFunctionBarrier (Esri::ArcGISRuntime::UtilityTraceFunction *traceFunction , Esri::ArcGISRuntime::UtilityAttributeComparisonOperator comparisonOperator , const QVariant &value, QObject *parent = nullptr)
Creates a barrier that stops tracing when a UtilityTraceFunction compared to a value evaluates to true.
- traceFunction - The calculation to perform.
- comparisonOperator - The operator used for the comparison.
- value - The value to compare against. The type of this numeric value depends on the UtilityNetworkAttributeDataType of the UtilityNetworkAttribute.
- parent - an optional parent QObject.
The type of the numeric value is dependent on the UtilityNetworkAttributeDataType of the UtilityNetworkAttribute.
[override virtual] UtilityTraceFunctionBarrier::~UtilityTraceFunctionBarrier ()
Destructor.
Esri::ArcGISRuntime::UtilityAttributeComparisonOperator UtilityTraceFunctionBarrier::comparisonOperator () const
Returns the operator used for the comparison.
Esri::ArcGISRuntime::UtilityTraceFunction *UtilityTraceFunctionBarrier::traceFunction () const
Returns the calculation to perform.
QVariant UtilityTraceFunctionBarrier::value() const
Returns the value to compare against.