Skip To Content ArcGIS for Developers Sign In Dashboard

ReverseGeocodeParameters Class


Parameters for reverse geocoding using a LocatorTask. More...

Header: #include <ReverseGeocodeParameters>
Since: Esri::ArcGISRuntime 100.0

Public Functions

ReverseGeocodeParameters(const ReverseGeocodeParameters &other)
ReverseGeocodeParameters(ReverseGeocodeParameters &&other)
QStringList featureTypes() const
bool isForStorage() const
double maxDistance() const
int maxResults() const
QString outputLanguageCode() const
SpatialReference outputSpatialReference() const
QStringList resultAttributeNames() const
void setFeatureTypes(const QStringList &featureTypes)
void setForStorage(bool forStorage)
void setMaxDistance(double maxDistance)
void setMaxResults(int maxResults)
void setOutputLanguageCode(const QString &outputLanguageCode)
void setOutputSpatialReference(const SpatialReference &outputSpatialReference)
void setResultAttributeNames(const QStringList &resultAttributeNames)
ReverseGeocodeParameters &operator=(const ReverseGeocodeParameters &other)
ReverseGeocodeParameters &operator=(ReverseGeocodeParameters &&other)

Detailed Description

Parameters for reverse geocoding using a LocatorTask.

ReverseGeocodeParameters are not required to reverse geocode with the LocatorTask, but they allow for more fine grain preferences to be applied to the task. Use ReverseGeocodeParameters when reverse geocoding to set the maximum distance to be used from an input point, or to set the maximum results to be returned from a reverse geocode operation.

Member Function Documentation


Default constructor.

ReverseGeocodeParameters::ReverseGeocodeParameters(const ReverseGeocodeParameters &other)

Copy constructor from other ReverseGeocodeParameters.

ReverseGeocodeParameters::ReverseGeocodeParameters(ReverseGeocodeParameters &&other)

Move constructor from other ReverseGeocodeParameters.



QStringList ReverseGeocodeParameters::featureTypes() const

Returns the list of feature types used for reverse geocoding.

See also setFeatureTypes().

bool ReverseGeocodeParameters::isForStorage() const

Returns whether the results can be used for storage.

double ReverseGeocodeParameters::maxDistance() const

Returns the maximum radial distance in meters to search for an address from the specified location.

See also setMaxDistance().

int ReverseGeocodeParameters::maxResults() const

Returns the maximum results to be returned by a reverse geocoding operation.

See also setMaxResults().

QString ReverseGeocodeParameters::outputLanguageCode() const

Returns the output two-digit language code.

For example, AR for Argentina, US for United States, and TR for Turkey.

See also setOutputLanguageCode() and Geocoding Language Codes.

SpatialReference ReverseGeocodeParameters::outputSpatialReference() const

Returns the output spatial reference of the GeocodeResult.

See also setOutputSpatialReference().

QStringList ReverseGeocodeParameters::resultAttributeNames() const

Returns a list of names of the attributes returned in the GeocodeResult.

See also setResultAttributeNames().

void ReverseGeocodeParameters::setFeatureTypes(const QStringList &featureTypes)

Sets the list of feature types used for reverse geocoding to featureTypes.

Initially this is an empty list, which means no feature type filtering is done. Add entries to this list for each feature type for which results are required.

Note: Currently only one feature type has any effect - specifying "intersection" causes the nearest street intersection to be returned.

See also featureTypes().

void ReverseGeocodeParameters::setForStorage(bool forStorage)

Sets whether the results can be used forStorage.

See also isForStorage().

void ReverseGeocodeParameters::setMaxDistance(double maxDistance)

Sets the maximum radial distance to search for an address from the specified location to maxDistance meters.

Maximum distance can be used as a tolerance, so that only addresses within a certain distance of the specified location will be returned in the result. Valid values range from 1000 to 50000. If no distance value is specified, the value is assumed to be 1000 meters.

See also maxDistance().

void ReverseGeocodeParameters::setMaxResults(int maxResults)

Sets the maxResults to be returned by a reverse geocoding operation.

See also maxResults().

void ReverseGeocodeParameters::setOutputLanguageCode(const QString &outputLanguageCode)

Sets the two-digit outputLanguageCode.

See also outputLanguageCode().

void ReverseGeocodeParameters::setOutputSpatialReference(const SpatialReference &outputSpatialReference)

Sets the outputSpatialReference of the GeocodeResult.

See also outputSpatialReference().

void ReverseGeocodeParameters::setResultAttributeNames(const QStringList &resultAttributeNames)

Sets a list of resultAttributeNames returned in the GeocodeResult.

Check the LocatorInfo::ResultAttributes for a list of available attributes.

See also resultAttributeNames().

ReverseGeocodeParameters &ReverseGeocodeParameters::operator=(const ReverseGeocodeParameters &other)

Assignment operator from other ReverseGeocodeParameters.

ReverseGeocodeParameters &ReverseGeocodeParameters::operator=(ReverseGeocodeParameters &&other)

Move operator from other ReverseGeocodeParameters.

Feedback on this topic?