Skip To Content ArcGIS for Developers Sign In Dashboard

GeoprocessingDataFile Class

(Esri::ArcGISRuntime::GeoprocessingDataFile)

A data file input or output parameter. More...

Header: #include <GeoprocessingDataFile>
Since: Esri::ArcGISRuntime 100.0
Inherits: GeoprocessingParameter and RemoteResource
Inherited By:

Esri::ArcGISRuntime::GeoprocessingRaster

Public Functions

GeoprocessingDataFile(QObject *parent = nullptr)
GeoprocessingDataFile(const QUrl &url, QObject *parent = nullptr)
GeoprocessingDataFile(const QUrl &url, Credential *credential, QObject *parent = nullptr)
~GeoprocessingDataFile()
TaskWatcher fetchFile(const QString &filePath)
QString inputFilePath() const
void setInputFilePath(const QString &path)
void setUploadId(const QString &uploadId)
void setUrl(const QUrl &url)
QString uploadId() const

Reimplemented Public Functions

virtual Credential *credential() const
virtual RequestConfiguration requestConfiguration() const
virtual void setRequestConfiguration(const RequestConfiguration &requestConfiguration)
virtual QUrl url() const

Signals

void fetchFileCompleted(QUuid taskId, const QString &filePath)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

A data file input or output parameter.

Corresponds to GPDataFile parameter type on the service.

Member Function Documentation

GeoprocessingDataFile::GeoprocessingDataFile(QObject *parent = nullptr)

Constructor that accepts an optional parent object.

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

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

GeoprocessingDataFile::GeoprocessingDataFile(const QUrl &url, 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.

GeoprocessingDataFile::~GeoprocessingDataFile()

Destructor.

[virtual] Credential *GeoprocessingDataFile::credential() const

Reimplemented from RemoteResource::credential().

Returns the security credential used to access the resource.

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

This function was introduced in Esri::ArcGISRuntime 100.1.

TaskWatcher GeoprocessingDataFile::fetchFile(const QString &filePath)

Creates a task to fetch the file at url into a file or folder at filePath.

If filePath is a directory, the file will be given the name of the file taken from the end of url. The full file path will be available as the returned task's result. Alternatively filePath can be a destination filename within an existing directory. Note that any pre-existing file at that location with the same name will be deleted first.

[signal] void GeoprocessingDataFile::fetchFileCompleted(QUuid taskId, const QString &filePath)

The signal emitted when the fetchFile task completes.

  • taskId - The task ID.
  • filePath - The full path to the output file.

QString GeoprocessingDataFile::inputFilePath() const

Returns the input file path of the data.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setInputFilePath().

[virtual] RequestConfiguration GeoprocessingDataFile::requestConfiguration() const

Reimplemented from RemoteResource::requestConfiguration().

Returns the RequestConfiguration in use by this object.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setRequestConfiguration().

void GeoprocessingDataFile::setInputFilePath(const QString &path)

Sets the input file path of the data path.

Sets the input file path of this parameter. This should be the location on disk of a file that will be uploaded to the server that the geoprocessing task will run on.

Note: Set this only for input parameters. This property will be ignored if uploadId is set.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also inputFilePath().

[virtual] void GeoprocessingDataFile::setRequestConfiguration(const RequestConfiguration &requestConfiguration)

Reimplemented from RemoteResource::setRequestConfiguration().

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 GeoprocessingDataFile::setUploadId(const QString &uploadId)

Sets the upload ID of this parameter to uploadId.

This should be the item ID of an item in the geoprocessing service's.

Note: Set this only for input parameters. This will be the upload ID of an item previously uploaded to the server. If this property is set it will cause both the inputFilePath and URL properties to be ignored.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also uploadId().

void GeoprocessingDataFile::setUrl(const QUrl &url)

Sets the URL of the data file to url.

If this object represents an input parameter, set this to a URL of the input data file. Ensure this URL is accessible to the service. A geoprocessing service can have an uploads REST resource associated with it for placing inputs.

If this object represents an output parameter, this will be populated with the URL location of the output file on the service. The file can be retrieved by using fetchFile.

Note: If inputFilePath or uploadId are set the URL property will be ignored.

See also url().

QString GeoprocessingDataFile::uploadId() const

Returns the upload ID of this parameter.

This will match the ID of an item in the geoprocessing service's uploads resource.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setUploadId().

[virtual] QUrl GeoprocessingDataFile::url() const

Reimplemented from RemoteResource::url().

Returns the URL of the data file.

See also setUrl().


Feedback on this topic?