Skip To Content ArcGIS for Developers Sign In Dashboard

GeoprocessingFeatures Class

class Esri::ArcGISRuntime::GeoprocessingFeatures

A features (or records) input or output parameter. More...

Header: #include <GeoprocessingFeatures>
Since: Esri::ArcGISRuntime 100.0
Inherits: Esri::ArcGISRuntime::GeoprocessingParameter and Esri::ArcGISRuntime::RemoteResource

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

GeoprocessingFeatures(Esri::ArcGISRuntime::FeatureSet *features, QObject *parent = nullptr)
GeoprocessingFeatures(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
GeoprocessingFeatures(const QUrl &url, QObject *parent = nullptr)
GeoprocessingFeatures(QObject *parent = nullptr)
virtual ~GeoprocessingFeatures() override
bool canFetchOutputFeatures() const
Esri::ArcGISRuntime::FeatureSet *features() const
Esri::ArcGISRuntime::TaskWatcher fetchOutputFeatures()
void setFeatures(Esri::ArcGISRuntime::FeatureSet *featureSet)
void setUrl(const QUrl &url)

Reimplemented Public Functions

virtual Esri::ArcGISRuntime::Credential *credential() const override
virtual Esri::ArcGISRuntime::RequestConfiguration requestConfiguration() const override
virtual void setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override
virtual QUrl url() const override

Signals

void fetchOutputFeaturesCompleted(QUuid taskId)

Detailed Description

Corresponds to GPRecordSet and GPFeatureRecordSetLayer parameter types on the service.

When Features are returned as an output parameter, the returned features are provided in a GeoprocessingFeatureSet. These features can be visualized on a map using a temporary Graphic on a GraphicsOverlay or using a FeatureCollectionTable on a FeatureCollectionLayer. If the geoprocessing service used is configured to use a result map server, then GeoprocessingResult::mapImageLayer was populated and it can be used to visualize the results using the symbology predefined by the service.

When providing GeoprocessingFeatures as an input to the geoprocessing task, features can be provided directly from the FeatureQueryResult that was returned from the FeatureTable. If there is a need to create a new set of features or records, FeatureCollectionTable can be used.

Note: A feature contains a geometry and some number of attributes. A record (or a row) is a feature that doesn't contain a geometry, only attributes.

Member Function Documentation

GeoprocessingFeatures::GeoprocessingFeatures(Esri::ArcGISRuntime::FeatureSet *features, QObject *parent = nullptr)

Constructor that accepts a FeatureSet (features) and an optional parent object.

GeoprocessingFeatures::GeoprocessingFeatures(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Constructor that accepts an initial URL to a data file (url), a credential and an optional parent object.

This function was introduced in Esri::ArcGISRuntime 100.1.

GeoprocessingFeatures::GeoprocessingFeatures(const QUrl &url, QObject *parent = nullptr)

Constructor that accepts a URL (url) to a feature set for input, and an optional parent object.

GeoprocessingFeatures::GeoprocessingFeatures(QObject *parent = nullptr)

Constructor that accepts an optional parent object.

[signal] void GeoprocessingFeatures::fetchOutputFeaturesCompleted(QUuid taskId)

The signal emitted when the fetchOutputFeatures task with the ID taskId completes.

[override virtual] GeoprocessingFeatures::~GeoprocessingFeatures()

Destructor.

bool GeoprocessingFeatures::canFetchOutputFeatures() const

Returns whether features can be fetched from the service of an output parameter.

This property applies to output parameters. It indicates that the parameter is an output parameter that can fetch features from the geoprocessing service. Depending on the type of the service, the features may already be available.

If features are not present then this property indicates that you can use fetchOutputFeatures to request features, asynchronously updating the features property.

[override virtual] Esri::ArcGISRuntime::Credential *GeoprocessingFeatures::credential() const

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access the features.

Note: Only applicable if using an online resource that is secured.

This function was introduced in Esri::ArcGISRuntime 100.1.

Esri::ArcGISRuntime::FeatureSet *GeoprocessingFeatures::features() const

Returns the FeatureSet that is the source of the features.

See also setFeatures().

Esri::ArcGISRuntime::TaskWatcher GeoprocessingFeatures::fetchOutputFeatures()

Creates a task to fetch features.

When the task completes, the features are available on the features property.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration GeoprocessingFeatures::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this object.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setRequestConfiguration().

void GeoprocessingFeatures::setFeatures(Esri::ArcGISRuntime::FeatureSet *featureSet)

Sets the FeatureSet that is the source of the features to featureSet.

See also features().

[override virtual] void GeoprocessingFeatures::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this object to requestConfiguration.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also requestConfiguration().

void GeoprocessingFeatures::setUrl(const QUrl &url)

Sets the URL of the source of the features to url.

See also url().

[override virtual] QUrl GeoprocessingFeatures::url() const

Reimplements: RemoteResource::url() const.

Returns the URL of the source of the features.

See also setUrl().


Feedback on this topic?