ArcGIS Developers

LocalGeoprocessingService Class

class Esri::ArcGISRuntime::LocalGeoprocessingService

A local geoprocessing service which runs on an instance of Local Server. More...

Header: #include <LocalGeoprocessingService>
Inherits: Esri::ArcGISRuntime::LocalService

Public Functions

LocalGeoprocessingService(const QString &packagePath, QObject *parent = nullptr)
virtual ~LocalGeoprocessingService() override
int maximumRecords() const
Esri::ArcGISRuntime::GeoprocessingServiceType serviceType() const
void setMaximumRecords(int maxRecords)
void setServiceType(Esri::ArcGISRuntime::GeoprocessingServiceType serviceType)

Detailed Description

Note: Local server is only available on Windows and Linux.

A local geoprocessing service requires a geoprocessing package file (.gpkx) which has been authored in ArcGIS Pro. A LocalGeoprocessingService produces geoprocessing results using the geoprocessing package.

Use a GeoprocessingTask to submit requests to a local geoprocessing service.

Member Function Documentation

LocalGeoprocessingService::LocalGeoprocessingService(const QString &packagePath, QObject *parent = nullptr)

Constructor that takes a path to the geoprocessing package file (packagePath) and an optional parent.

[override virtual] LocalGeoprocessingService::~LocalGeoprocessingService()


int LocalGeoprocessingService::maximumRecords() const

Returns the maximum number of records returned by the service.

See also setMaximumRecords().

Esri::ArcGISRuntime::GeoprocessingServiceType LocalGeoprocessingService::serviceType() const

Gets the service type.

See also setServiceType().

void LocalGeoprocessingService::setMaximumRecords(int maxRecords)

Sets the maximum number of records returned by the service to maxRecords.

The default value is 10000. This value must be set before the service starts. It cannot be set on a running service.

See also maximumRecords().

void LocalGeoprocessingService::setServiceType(Esri::ArcGISRuntime::GeoprocessingServiceType serviceType)

Sets the service type to serviceType.

This method may only be called when the service is not started. It cannot be set on a running service. *

See also serviceType().

Feedback on this topic?