A function for computing values during a network trace. More...
| Header: | #include <UtilityTraceFunction.h> |
| Since: | Esri::ArcGISRuntime 100.7 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| UtilityTraceFunction(Esri::ArcGISRuntime::UtilityTraceFunctionType functionType, Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute, QObject *parent = nullptr) | |
| UtilityTraceFunction(Esri::ArcGISRuntime::UtilityTraceFunctionType functionType, Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute, Esri::ArcGISRuntime::UtilityTraceCondition *condition, QObject *parent = nullptr) | |
| virtual | ~UtilityTraceFunction() override |
| Esri::ArcGISRuntime::UtilityTraceCondition * | condition() const |
| Esri::ArcGISRuntime::UtilityTraceFunctionType | functionType() const |
| Esri::ArcGISRuntime::UtilityNetworkAttribute * | networkAttribute() const |
| void | setCondition(Esri::ArcGISRuntime::UtilityTraceCondition *condition) |
Detailed Description
Functions are evaluated at each applicable network element. The meaning of applicable varies depending on the Tracer. For an upstream trace, the functions are evaluated for each upstream element. For a downstream trace, the functions are evaluated for each element in the subnetwork.
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.
Member Function Documentation
UtilityTraceFunction::UtilityTraceFunction (Esri::ArcGISRuntime::UtilityTraceFunctionType functionType , Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute , QObject *parent = nullptr)
Creates a function object to compute a value from a network attribute.
- functionType - The calculation to perform.
- networkAttribute - The UtilityNetworkAttribute to use with the calculation
- parent - The optional parent QObject.
[since Esri::ArcGISRuntime 100.9] UtilityTraceFunction::UtilityTraceFunction (Esri::ArcGISRuntime::UtilityTraceFunctionType functionType , Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute , Esri::ArcGISRuntime::UtilityTraceCondition *condition, QObject *parent = nullptr)
Creates a function object to compute a value from a network attribute.
- functionType - The calculation to perform
- networkAttribute - The UtilityNetworkAttribute to use with the calculation
- condition - A UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition
- parent - The optional parent QObject
This function was introduced in Esri::ArcGISRuntime 100.9.
[override virtual] UtilityTraceFunction::~UtilityTraceFunction ()
Destructor.
[since Esri::ArcGISRuntime 100.9] Esri::ArcGISRuntime::UtilityTraceCondition *UtilityTraceFunction::condition() const
Returns a UtilityTraceCondition to use to restrict the functional calculation to features that satisfy the condition.
This function was introduced in Esri::ArcGISRuntime 100.9.
See also setCondition().
Esri::ArcGISRuntime::UtilityTraceFunctionType UtilityTraceFunction::functionType () const
Returns the calculation to perform.
Esri::ArcGISRuntime::UtilityNetworkAttribute *UtilityTraceFunction::networkAttribute () const
Returns the UtilityNetworkAttribute to use with the calculation.
[since Esri::ArcGISRuntime 100.9] void UtilityTraceFunction::setCondition (Esri::ArcGISRuntime::UtilityTraceCondition *condition)
Sets the condition to condition.
This function was introduced in Esri::ArcGISRuntime 100.9.
See also condition.