Skip To Content ArcGIS for Developers Sign In Dashboard

GeocodeResult Class

(Esri::ArcGISRuntime::GeocodeResult)

The result class returned from a geocode or reverse geocode operation of a LocatorTask. More...

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

Public Functions

GeocodeResult()
GeocodeResult(const GeocodeResult &other)
GeocodeResult(GeocodeResult &&other)
~GeocodeResult()
QVariantMap attributes() const
Point displayLocation() const
Envelope extent() const
Point inputLocation() const
bool isEmpty() const
QString label() const
Point routeLocation() const
double score() const
GeocodeResult &operator=(const GeocodeResult &other)
GeocodeResult &operator=(GeocodeResult &&other)

Detailed Description

The result class returned from a geocode or reverse geocode operation of a LocatorTask.

Geocoding takes an address or place name, and converts it into real-world coordinates. Reverse geocoding does the opposite, and converts real-world coordinates into an address or place name. These operations are available on the LocatorTask class. Obtain this result from the LocatorTask::geocodeCompleted signal.

Member Function Documentation

GeocodeResult::GeocodeResult()

Default constructor.

GeocodeResult::GeocodeResult(const GeocodeResult &other)

Copy constructor from other GeocodeResult.

GeocodeResult::GeocodeResult(GeocodeResult &&other)

Move constructor from other GeocodeResult.

GeocodeResult::~GeocodeResult()

Destructor.

QVariantMap GeocodeResult::attributes() const

Returns the attributes of the GeocodeResult.

These attributes can be defined in GeocodeParameters::setResultAttributeNames.

Point GeocodeResult::displayLocation() const

Returns the display location of the GeocodeResult.

For example, if searching for a park, the returned point would be near the center of the park.

Envelope GeocodeResult::extent() const

Returns the extent of the GeocodeResult.

The extent can be used for setting the viewpoint of the map view to the geocode result.

Point GeocodeResult::inputLocation() const

Returns the input location of the GeocodeResult.

Note: Input location only applies if the result is from a reverse geocode.

bool GeocodeResult::isEmpty() const

Returns whether this GeocodeResult is empty.

QString GeocodeResult::label() const

Returns the label of the GeocodeResult.

Point GeocodeResult::routeLocation() const

Returns the route location of the GeocodeResult.

For example, if searching for a park, the returned point would be near the entrance point to the park.

double GeocodeResult::score() const

Returns the score of the GeocodeResult.

See also GeocodeParameters::minScore.

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

Assignment operator from other GeocodeResult.

GeocodeResult &GeocodeResult::operator=(GeocodeResult &&other)

Move operator from other GeocodeResult.


Feedback on this topic?