A task to compute areas that can be serviced (reached) from a given location. More...
Member Function Documentation[explicit, since Esri::ArcGISRuntime 100.2] ServiceAreaTask::ServiceAreaTask(Esri::ArcGISRuntime::TransportationNetworkDataset *transportationNetworkDataset, QObject *parent = nullptr)
Constructor that takes a transportationNetworkDataset with an optional parent.
This function was introduced in Esri::ArcGISRuntime 100.2.
[explicit] ServiceAreaTask::ServiceAreaTask(const QUrl &url, QObject *parent = nullptr)
Creates a service area task with a URL.
[since Esri::ArcGISRuntime 100.2] ServiceAreaTask::ServiceAreaTask(const QString &databasePath, const QString &networkName, QObject *parent = nullptr)
Constructor that takes a databasePath and networkName, with an optional parent.
This function was introduced in Esri::ArcGISRuntime 100.2.
[override virtual noexcept] ServiceAreaTask::~ServiceAreaTask()
Destructor.
[override virtual, since Esri::ArcGISRuntime 100.10] QString ServiceAreaTask::apiKey() const
Reimplements: ApiKeyResource::apiKey() const.
Returns the API key allows your app to access ArcGIS location services and private portal items.
An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the `Generate API keys` privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.
Note: An API key created with a referrer is not supported. If you need service requests to include the referrer, use the SDK's functionality to intercept the request and add an HTTP referer header.
In addition to setting an ArcGISRuntimeEnvironment::apiKey at a global level for your application, you can set it on any class that implements ApiKeyResource. This overrides the ArcGISRuntimeEnvironment::apiKey and enables more granular usage telemetry and management of ArcGIS location resources used by your app.
Classes that expose an API key property by implementing ApiKeyResource include:
For more information, see API key authentication and Types of authentication.
This function was introduced in Esri::ArcGISRuntime 100.10.
See also setApiKey().
[override virtual] void ServiceAreaTask::cancelLoad()
Reimplements: Loadable::cancelLoad().
See Loadable.
[since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::ServiceAreaParameters> ServiceAreaTask::createDefaultParametersAsync()
Creates default service area parameters from the service. Retrieves the default parameters as defined by the service. 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.
[signal] void ServiceAreaTask::doneLoading(const Esri::ArcGISRuntime::Error &loadError)
Signal emitted when this object is done loading.
Note: If there is a load error it will also be emitted on the errorOccurred signal.
[override virtual] void ServiceAreaTask::load()
Reimplements: Loadable::load().
See Loadable.
[override virtual] Esri::ArcGISRuntime::Error ServiceAreaTask::loadError() const
Reimplements: Loadable::loadError() const.
See Loadable.
[override virtual] Esri::ArcGISRuntime::LoadStatus ServiceAreaTask::loadStatus() const
Reimplements: Loadable::loadStatus() const.
See Loadable.
[signal] void ServiceAreaTask::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)
Signal emitted when the load status changes for this object.
See also Loadable.
[override virtual] void ServiceAreaTask::retryLoad()
Reimplements: Loadable::retryLoad().
See Loadable.
Esri::ArcGISRuntime::ServiceAreaTaskInfo ServiceAreaTask::serviceAreaTaskInfo() constReturns the ServiceAreaTaskInfo for this ServiceAreaTask.
Wait until this ServiceAreaTask is finished loading before attempting to obtain the ServiceAreaTaskInfo.
[override virtual, since Esri::ArcGISRuntime 100.10] void ServiceAreaTask::setApiKey(const QString &apiKey)
Reimplements: ApiKeyResource::setApiKey(const QString &apiKey).
Sets the API key to apiKey.
This function was introduced in Esri::ArcGISRuntime 100.10.
See also apiKey().
[since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::ServiceAreaResult> ServiceAreaTask::solveServiceAreaAsync(const Esri::ArcGISRuntime::ServiceAreaParameters &serviceAreaParameters)
Solves a service area passing in a parameters object.
Executes the ServiceAreaParameters defined for this ServiceAreaTask and returns a ServiceAreaResult containing the 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.
[since Esri::ArcGISRuntime 100.2] Esri::ArcGISRuntime::TransportationNetworkDataset *ServiceAreaTask::transportationNetworkDataset() const
Returns the TransportationNetworkDataset used to construct this ServiceAreaTask.
This function was introduced in Esri::ArcGISRuntime 100.2.
[override virtual] QUrl ServiceAreaTask::url() const
Reimplements: RemoteResource::url() const.
Returns the URL to the online service.
Only applicable to online service area.
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