A network attribute in a utility network. More...
| Header: | #include <UtilityNetworkAttribute.h> |
| Since: | Esri::ArcGISRuntime 100.6 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~UtilityNetworkAttribute() override |
| Esri::ArcGISRuntime::UtilityNetworkAttributeDataType | dataType() const |
| Esri::ArcGISRuntime::Domain | domain() const |
| bool | isApportionable() const |
| bool | isSubstitution() const |
| bool | isSystemDefined() const |
| QString | name() const |
| Esri::ArcGISRuntime::UtilityNetworkAttribute * | networkAttributeToSubstitute() const |
Detailed Description
A network attribute is an attribute that is copied from a feature and stored in the topological index. The utility network tracing task can read and make decisions using network attributes that are stored directly in the topological index, without needing to fetch the individual features to get their attributes, thus improving analysis performance.
The network attributes in a topological index are limited to specific data types and to an aggregate size.
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
[override virtual] UtilityNetworkAttribute::~UtilityNetworkAttribute ()
Destructor.
Esri::ArcGISRuntime::UtilityNetworkAttributeDataType UtilityNetworkAttribute::dataType () const
Returns the data type of the utility network attribute.
The network attributes in a topological index are limited to specific data types.
[since Esri::ArcGISRuntime 100.7] Esri::ArcGISRuntime::Domain UtilityNetworkAttribute::domain() const
Returns the Domain associated with this network attribute.
If no domain is assigned, Domain::isEmpty will be true.
This function was introduced in Esri::ArcGISRuntime 100.7.
[since Esri::ArcGISRuntime 100.7] bool UtilityNetworkAttribute::isApportionable () const
Returns whether the network attribute should be apportioned across the length of linear features.
For example, if a point is chosen 25% of the distance along an edge, 25% of the attribute's value is assigned to the 25% (shorter) part of the edge, and 75% of the attribute's value is assigned to the 75% (longer) part of the edge.
This function was introduced in Esri::ArcGISRuntime 100.7.
[since Esri::ArcGISRuntime 100.7] bool UtilityNetworkAttribute::isSubstitution () const
Returns whether the UtilityNetworkAttribute is used as a substitution for another network attribute at tap features.
If this value is true, this network attribute is the network attribute to substitute for UtilityNetworkAttribute::networkAttributeToSubstitute at tap features. Taps are special features, identified with the "Subnetwork Tap" category, that work with attribute substitution. See the online help for more information.
This function was introduced in Esri::ArcGISRuntime 100.7.
[since Esri::ArcGISRuntime 100.7] bool UtilityNetworkAttribute::isSystemDefined () const
Returns whether the network attribute has been added by the system.
This function was introduced in Esri::ArcGISRuntime 100.7.
QString UtilityNetworkAttribute::name() const
Returns the name of the utility network attribute.
[since Esri::ArcGISRuntime 100.7] Esri::ArcGISRuntime::UtilityNetworkAttribute *UtilityNetworkAttribute::networkAttributeToSubstitute () const
This property returns the UtilityNetworkAttribute that is substituted for this UtilityNetworkAttribute at tap features.
This property is only set if UtilityNetworkAttribute::isSubstitution is set to true. Taps are special features, identified with the "Subnetwork Tap" category, that work with attribute substitution. See the online help for more information.
This function was introduced in Esri::ArcGISRuntime 100.7.