A function for computing values during a network trace. More...
| Header | #include <Utility |
| Since | Esri |
| Inherits | Esri |
Public Functions
| Utility | |
(since Esri | Utility |
(since Esri | Utility |
(since Esri | Utility |
| virtual | ~ |
(since Esri Esri | condition() const |
(since Esri QString | function |
| Esri | function |
| Esri | network |
(since Esri void | set |
(since Esri void | set |
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.
[since Esri::ArcGISRuntime 300.1] UtilityTraceFunction::UtilityTraceFunction (Esri::ArcGISRuntime::UtilityTraceFunctionType functionType , Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute , const QString &functionName , QObject *parent = nullptr)
Creates a named function object to compute a value from a network attribute.
- functionType - The calculation to perform.
- networkAttribute - The UtilityNetworkAttribute to use with the calculation.
- functionName - A user-defined name for this trace function.
- parent - The optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 300.1.
[since Esri::ArcGISRuntime 300.1] UtilityTraceFunction::UtilityTraceFunction (Esri::ArcGISRuntime::UtilityTraceFunctionType functionType , Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute , Esri::ArcGISRuntime::UtilityTraceCondition *condition, const QString &functionName , QObject *parent = nullptr)
Creates a named 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.
- functionName - A user-defined name for this trace function.
- parent - The optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 300.1.
[override virtual noexcept] 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().
[since Esri::ArcGISRuntime 300.1] QString UtilityTraceFunction::functionName () const
Returns a user-defined name for this trace function. Use this name to define a label for the corresponding function result in the trace output. The name can describe the function type applied to a network attribute and any condition that constrains the calculation.
This function was introduced in Esri::ArcGISRuntime 300.1.
See also setFunctionName().
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.
[since Esri::ArcGISRuntime 300.1] void UtilityTraceFunction::setFunctionName (const QString &functionName )
Sets the functionName to functionName.
This function was introduced in Esri::ArcGISRuntime 300.1.
See also functionName.