[explicit, since Esri::ArcGISRuntime 200.8]
UtilityNetwork::UtilityNetwork(Esri::ArcGISRuntime::ServiceGeodatabase *serviceGeodatabase, QObject *parent = nullptr)
Creates a utility network from the specified service geodatabase that contains it.
The ServiceGeodatabase provides the ability to switch to a branch version, manage edits, or query related records of tables participating in this UtilityNetwork.
This function was introduced in Esri::ArcGISRuntime 200.8.
[override virtual noexcept]
UtilityNetwork::~UtilityNetwork()
Destructor.
[since Esri::ArcGISRuntime 200.5]
QFuture<void> UtilityNetwork::addAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation *association)
Adds an association between two utility elements in this utility network.
Adding an association may also update the features that participate in the association.
Use canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*) to determine if you can successfully add this association.
This method requires that:
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
{deleteAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)}, {Esri::ArcGISRuntime::UtilityNetwork::deleteAssociationsAsync(const QList<Esri::ArcGISRuntime::UtilityAssociation*>&)} {deleteAssociationsAsync(const QList<Esri::ArcGISRuntime::UtilityAssociation*>&)}
This function was introduced in Esri::ArcGISRuntime 200.5.
See also Esri::ArcGISRuntime::UtilityNetwork::deleteAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*).
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::UtilityAssociation *>> UtilityNetwork::associationsAsync(Esri::ArcGISRuntime::UtilityElement *element, QObject *parent = nullptr)
Returns a list of all UtilityAssociation objects present in the geodatabase for a given UtilityElement.
The result is a list of all associations â connectivity associations, containment associations, structural attachment associations â that include the given UtilityElement object. The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::UtilityAssociation *>> UtilityNetwork::associationsAsync(const Esri::ArcGISRuntime::Envelope &extent, QObject *parent = nullptr)
Returns a list of all UtilityAssociation objects (with their geometry) present in the geodatabase for a given Envelope.
The result is a list of connectivity and structural attachment associations. Containment associations are not returned because no geometric relationship is defined between a container and its contents. The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::UtilityAssociation *>> UtilityNetwork::associationsAsync(Esri::ArcGISRuntime::UtilityElement *element, Esri::ArcGISRuntime::UtilityAssociationType type, QObject *parent = nullptr)
Returns a list of all UtilityAssociation objects of type UtilityAssociationType present in the geodatabase for a given UtilityElement.
The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::UtilityAssociation *>> UtilityNetwork::associationsAsync(const Esri::ArcGISRuntime::Envelope &extent, Esri::ArcGISRuntime::UtilityAssociationType type, QObject *parent = nullptr)
Returns a list of all UtilityAssociation objects (with their geometry) of type UtilityAssociationType present in the geodatabase for a given Envelope.
Containment associations are not returned because no geometric relationship is defined between a container and its contents; consider using associationsAsync(Esri::ArcGISRuntime::UtilityElement*, Esri::ArcGISRuntime::UtilityAssociationType, QObject*) instead. The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
[since Esri::ArcGISRuntime 200.5]
QFuture<bool> UtilityNetwork::canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation *association)
Checks if the utility association can be added to the utility network.
Checks that all of the following conditions are met:
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.5.
See also canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociationType, Esri::ArcGISRuntime::UtilityElement*, Esri::ArcGISRuntime::UtilityElement*) and canDeleteAssociations.
[since Esri::ArcGISRuntime 200.5]
QFuture<bool> UtilityNetwork::canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociationType associationType, Esri::ArcGISRuntime::UtilityElement *fromElement, Esri::ArcGISRuntime::UtilityElement *toElement)
Checks if a utility association with the specified type between the specified utility elements can be added to the utility network.
Checks that all of the following conditions are met:
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
{canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)}, {Esri::ArcGISRuntime::UtilityNetwork::canDeleteAssociations} {canDeleteAssociations}
This function was introduced in Esri::ArcGISRuntime 200.5.
See also Esri::ArcGISRuntime::UtilityNetwork::canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*).
[since Esri::ArcGISRuntime 200.5]
bool UtilityNetwork::canDeleteAssociations()
Returns whether associations can be deleted.
Checks that all of the following conditions are met:
{canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)}, {Esri::ArcGISRuntime::UtilityNetwork::canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociationType, Esri::ArcGISRuntime::UtilityElement*, Esri::ArcGISRuntime::UtilityElement*)} {canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociationType, Esri::ArcGISRuntime::UtilityElement*, Esri::ArcGISRuntime::UtilityElement*)}
This function was introduced in Esri::ArcGISRuntime 200.5.
See also Esri::ArcGISRuntime::UtilityNetwork::canAddAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*).
[override virtual]
void UtilityNetwork::cancelLoad()
Reimplements: Loadable::cancelLoad().
See Loadable.
Esri::ArcGISRuntime::UtilityElement *UtilityNetwork::createElementWithArcGISFeature(Esri::ArcGISRuntime::ArcGISFeature *arcGISFeature, Esri::ArcGISRuntime::UtilityTerminal *terminal = nullptr, QObject *parent = nullptr)Creates a UtilityElement from an ArcGISFeature and an optional UtilityTerminal.
If the optional UtilityTerminal is not supplied, and the feature's UtilityAssetType supports a UtilityTerminalConfiguration, a default UtilityTerminal will be assigned.
Esri::ArcGISRuntime::UtilityElement *UtilityNetwork::createElementWithAssetType(Esri::ArcGISRuntime::UtilityAssetType *assetType, const QUuid &globalId, Esri::ArcGISRuntime::UtilityTerminal *terminal = nullptr, QObject *parent = nullptr)Creates a UtilityElement from a UtilityAssetType, a global ID of a feature, and an optional UtilityTerminal.
If the optional UtilityTerminal is not supplied, and the feature's UtilityAssetType supports a UtilityTerminalConfiguration, a default UtilityTerminal will be assigned.
Esri::ArcGISRuntime::UtilityNetworkDefinition *UtilityNetwork::definition() constReturns the definition of the utility network.
The definition contains metadata about the associated utility network feature service. This definition is NULL until the utility network is loaded.
[since Esri::ArcGISRuntime 200.5]
QFuture<void> UtilityNetwork::deleteAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation *association)
Deletes an association from this utility network.
Deleting an association may also update the features that participate in the association.
Use canDeleteAssociations to determine if you can successfully delete associations.
This method requires that the association elements are accessible. Use UtilityElement::isValid to check feature accessibility to ensure it has not been filtered out. This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
{deleteAssociationsAsync(const QList<Esri::ArcGISRuntime::UtilityAssociation*>&)}, {Esri::ArcGISRuntime::UtilityNetwork::addAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)} {addAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)}
This function was introduced in Esri::ArcGISRuntime 200.5.
See also Esri::ArcGISRuntime::UtilityNetwork::deleteAssociationsAsync(const QList<Esri::ArcGISRuntime::UtilityAssociation*>&).
[since Esri::ArcGISRuntime 200.5]
QFuture<void> UtilityNetwork::deleteAssociationsAsync(const QList<Esri::ArcGISRuntime::UtilityAssociation *> &associations)
Deletes a collection of associations from this utility network.
Deleting these associations may also update the features that participate in these associations.
Use canDeleteAssociations to determine if you can successfully delete associations.
This method requires that the association elements are accessible. Use UtilityElement::isValid to check feature accessibility to ensure it has not been filtered out. This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
{deleteAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)}, {Esri::ArcGISRuntime::UtilityNetwork::addAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)} {addAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*)}
This function was introduced in Esri::ArcGISRuntime 200.5.
See also Esri::ArcGISRuntime::UtilityNetwork::deleteAssociationAsync(Esri::ArcGISRuntime::UtilityAssociation*).
[since Esri::ArcGISRuntime 200.3]
Esri::ArcGISRuntime::ArcGISFeatureTable *UtilityNetwork::dirtyAreaTable() const
Returns the dirty area table of the UtilityNetwork. A read-only table that can be used to query features that represent either:
A dirty area is created when modifications are made to feature geometry, asset group or asset type fields, network attribute fields, associations, or terminal configuration information.
The dirty area table is nullptr
until the utility network is loaded or if the utility network does not support the network state.
This function was introduced in Esri::ArcGISRuntime 200.3.
See also UtilityNetworkCapabilities::isSupportsNetworkState.
[signal]
void UtilityNetwork::doneLoading(const Esri::ArcGISRuntime::Error &loadError)
Signal emitted when this object is done loading.
loadError - The Error object.
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::ArcGISFeature *>> UtilityNetwork::featuresForElementsAsync(const QList<Esri::ArcGISRuntime::UtilityElement *> &elements, QObject *parent = nullptr)
Returns a collection of loaded ArcGISFeature objects that each correspond to one of a collection of UtilityElement objects.
Once the future is completed, all new ArcGISFeature results will be available in the ArcGISFeatureListModel immediately as well as the future's QList of results.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
See also featuresForElementsResult.
Esri::ArcGISRuntime::ArcGISFeatureListModel *UtilityNetwork::featuresForElementsResult() constReturns the list model of features that is the result of the featuresForElementsAsync task
The result list model will contain loaded ArcGISFeature objects corresponding to the collection of UtilityElement objects used in the task.
[since Esri::ArcGISRuntime 100.11]
Esri::ArcGISRuntime::Geodatabase *UtilityNetwork::geodatabase() const
Returns the Geodatabase that contains this UtilityNetwork.
The Geodatabase that contains this UtilityNetwork and is also used by the GeodatabaseFeatureTable in UtilityNetworkDefinition::networkSources.
Use this property to manage transactions, sync edits, or access tables participating in this UtilityNetwork.
This property is nullptr
when the UtilityNetwork is created from a ServiceGeodatabase or retrieved from a web map. Note that calling Geodatabase::close on a Geodatabase that contains this UtilityNetwork will render this UtilityNetwork unusable. An attempt to create an element, get associations, get features from elements, or perform a trace after this Geodatabase is closed will fail with ErrorType::GeodatabaseDatabaseClosed.
This function was introduced in Esri::ArcGISRuntime 100.11.
[override virtual]
void UtilityNetwork::load()
Reimplements: Loadable::load().
Loads the metadata for the object asynchronously.
Loads the metadata if the object is not loaded.
See Loadable.
[override virtual]
Esri::ArcGISRuntime::Error UtilityNetwork::loadError() const
Reimplements: Loadable::loadError() const.
Returns the load error.
See Loadable.
See also Error.
[override virtual]
Esri::ArcGISRuntime::LoadStatus UtilityNetwork::loadStatus() const
Reimplements: Loadable::loadStatus() const.
Returns the load status.
See Loadable.
See also LoadStatus.
[signal]
void UtilityNetwork::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)
Signal emitted when the load status changes for this object.
See also Loadable.
[since Esri::ArcGISRuntime 100.8]
QString UtilityNetwork::name() const
Returns the name of the UtilityNetwork.
This property is empty when UtilityNetwork is not loaded or UtilityNetwork is not retrieved from a Geodatabase.
This function was introduced in Esri::ArcGISRuntime 100.8.
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::UtilityNamedTraceConfiguration *>> UtilityNetwork::queryNamedTraceConfigurationsAsync(Esri::ArcGISRuntime::UtilityNamedTraceConfigurationQueryParameters *queryParameters, QObject *parent = nullptr)
Returns a list of UtilityNamedTraceConfiguration from the utility network.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
[override virtual]
void UtilityNetwork::retryLoad()
Reimplements: Loadable::retryLoad().
Loads or retries loading metadata for the object asynchronously.
Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.
See Loadable.
[since Esri::ArcGISRuntime 100.10]
Esri::ArcGISRuntime::ServiceGeodatabase *UtilityNetwork::serviceGeodatabase() const
Returns the ServiceGeodatabase of the UtilityNetwork
The ServiceGeodatabase used by the ServiceFeatureTable in UtilityNetworkDefinition::networkSources.
Use this property to switch to a branch version, manage edits, or query related records of tables participating in this UtilityNetwork.
This property is nullptr
when the UtilityNetwork is retrieved from a Geodatabase or mobile map.
Note that calling ServiceGeodatabase::closeAsync on a ServiceGeodatabase that is used by a UtilityNetwork will render this UtilityNetwork unusable. An attempt to create an element, get associations, get features from elements, or perform a trace after this ServiceGeodatabase is closed will fail with Error::errorType ErrorType::GeodatabaseDatabaseClosed.
This function was introduced in Esri::ArcGISRuntime 100.10.
[since Esri::ArcGISRuntime 200.3]
QFuture<Esri::ArcGISRuntime::UtilityNetworkState *> UtilityNetwork::stateAsync(QObject *parent = nullptr)
Returns a UtilityNetworkState that represents the current state of the utility network.
This state is unavailable if the utility network does not support the network state.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.3.
See also UtilityNetworkCapabilities::isSupportsNetworkState.
[since Esri::ArcGISRuntime 200.2]
QFuture<QList<Esri::ArcGISRuntime::UtilityTraceResult *>> UtilityNetwork::traceAsync(Esri::ArcGISRuntime::UtilityTraceParameters *traceParameters, QObject *parent = nullptr)
Begins a trace with the supplied UtilityTraceParameters.
Once the future is completed, all new UtilityTraceResult results will be available in the UtilityTraceResultListModel immediately as well as the future's QList of results.
If the UtilityTraceParameters::traceType in UtilityTraceParameters is a subnetwork-based trace, it must have a UtilityDomainNetwork set in the UtilityTraceConfiguration returned from UtilityTraceParameters::traceConfiguration.
This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.
See Working with QFuture for further details.
This function was introduced in Esri::ArcGISRuntime 200.2.
See also traceResult.
Esri::ArcGISRuntime::UtilityTraceResultListModel *UtilityNetwork::traceResult() constReturns the list model of UtilityTraceResult.
See also trace.
[override virtual]
QUrl UtilityNetwork::url() const
Reimplements: RemoteResource::url() const.
Returns the URL of the UtilityNetwork.
This property is empty when UtilityNetwork is retrieved from a Geodatabase.
[since Esri::ArcGISRuntime 200.3]
Esri::ArcGISRuntime::UtilityNetworkValidationJob *UtilityNetwork::validateNetworkTopology(const Esri::ArcGISRuntime::Envelope &extent)
Returns a job that when started will validate the utility network topology within the provided extent.
The geoprocessing execution type is GeoprocessingExecutionType::SynchronousExecute.
The job that is returned is dormant and needs to be explicitly started.
When working with an enterprise geodatabase, only a single session can run the validate operation at a time in the default version.
See Enable and validate network topology errors for more information on validation errors.
This function was introduced in Esri::ArcGISRuntime 200.3.
See also UtilityNetworkCapabilities::isSupportsValidateNetworkTopology.
[since Esri::ArcGISRuntime 200.3]
Esri::ArcGISRuntime::UtilityNetworkValidationJob *UtilityNetwork::validateNetworkTopology(const Esri::ArcGISRuntime::Envelope &extent, Esri::ArcGISRuntime::GeoprocessingExecutionType geoprocessingExecutionType)
Returns a job that when started will validate the utility network topology within the provided extent.
The preferred job execution type is GeoprocessingExecutionType::SynchronousExecute because it is faster to start up. For larger jobs, GeoprocessingExecutionType::SynchronousExecute can lead to timeouts, at which point GeoprocessingExecutionType::AsynchronousSubmit should be used. The job that is returned is dormant and needs to be explicitly started.
When working with an enterprise geodatabase, only a single session can run the validate operation at a time in the default version.
See Enable and validate network topology errors for more information on validation errors.
{UtilityNetworkCapabilities::isSupportsValidateNetworkTopology}
This function was introduced in Esri::ArcGISRuntime 200.3.
See also Esri::ArcGISRuntime::UtilityNetworkCapabilities::isSupportsValidateNetworkTopology.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4