Defines the supported capabilities for a utility network. More...
| Header: | #include <UtilityNetworkCapabilities.h> |
| Since: | Esri::ArcGISRuntime 200.0 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~UtilityNetworkCapabilities() override |
(since Esri::ArcGISRuntime 200.3) bool | isSupportsNetworkState() const |
| bool | isSupportsQueryAssociations() const |
| bool | isSupportsTrace() const |
(since Esri::ArcGISRuntime 200.3) bool | isSupportsValidateNetworkTopology() const |
Detailed Description
These non-configurable capabilities indicate which utility network operations are supported. They are dependent upon the utility network service capabilities or the contents of the geodatabase.
Relevant samples:
- Validate utility network topology: Demonstrates the workflow of getting the network state and validating the topology of a utility network.
Member Function Documentation
[override virtual noexcept] UtilityNetworkCapabilities::~UtilityNetworkCapabilities ()
Destructor.
[since Esri::ArcGISRuntime 200.3] bool UtilityNetworkCapabilities::isSupportsNetworkState () const
Returns true if this utility network supports network state, false otherwise. The network state is supported for a utility network if:
- Connected to a utility network feature service
- Full utility network model was requested when replica geodatabase was created
- Network topology was included with the stand-alone geodatabase exported from ArcGIS Pro
UtilityNetworkDefinition::schemaVersion older than 4 are not supported.
This function was introduced in Esri::ArcGISRuntime 200.3.
See also UtilityNetworkState and UtilityNetwork::stateAsync.
bool UtilityNetworkCapabilities::isSupportsQueryAssociations () const
Returns true if this utility network can query associations, false otherwise.
Access to the system-defined associations table is required to enable querying associations.
The associations table is available for a utility network if:
- Utility network feature service grants access to the association table
- Partial or full utility network model was requested when replica geodatabase was created
- Association table was included with the stand-alone geodatabase exported from ArcGIS Pro
See also UtilityNetworkSyncMode.
bool UtilityNetworkCapabilities::isSupportsTrace () const
Returns true if this utility network can run a trace, false otherwise.
Access to network topology is required to enable tracing capability.
The network topology is available for a utility network if:
- Utility network service has enabled network topology
- Full utility network model was requested when replica geodatabase was created and the network topology is enabled
- Network topology was included and enabled with the stand-alone geodatabase exported from ArcGIS Pro
See also UtilityNetworkSyncMode.
[since Esri::ArcGISRuntime 200.3] bool UtilityNetworkCapabilities::isSupportsValidateNetworkTopology () const
Returns true if this utility network can validate network topology, false otherwise.
Access to a feature service that has network topology enabled is required to validate network topology.
{UtilityNetwork::validateNetworkTopology(const Esri::ArcGISRuntime::Envelope&)}
This function was introduced in Esri::ArcGISRuntime 200.3.
See also Esri::ArcGISRuntime::UtilityNetwork::validateNetworkTopology(const Esri::ArcGISRuntime::Envelope&).