Skip To Content ArcGIS for Developers Sign In Dashboard

LocatorInfo Class

(Esri::ArcGISRuntime::LocatorInfo)

Information about an Address Locator. More...

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

Public Functions

LocatorInfo()
LocatorInfo(const LocatorInfo &other)
LocatorInfo(LocatorInfo &&other)
~LocatorInfo()
QString description() const
QList<LocatorAttribute> intersectionResultAttributes() const
bool isEmpty() const
bool isSupportsAddresses() const
bool isSupportsIntersections() const
bool isSupportsPoi() const
bool isSupportsSuggestions() const
QString name() const
QVariantMap properties() const
QList<LocatorAttribute> resultAttributes() const
QList<LocatorAttribute> searchAttributes() const
SpatialReference spatialReference() const
QString version() const
LocatorInfo &operator=(const LocatorInfo &other)
LocatorInfo &operator=(LocatorInfo &&other)

Detailed Description

Information about an Address Locator.

The LocatorInfo can be used to determine if certain capabilities are supported, such as whether the Locator supports suggestions or searching by intersection. The LocatorInfo also holds key bits of information, such as its SpatialReference, the search attributes it uses, and the version of locator it is. Check the LocatorInfo properties before performing certain LocatorTask operations, to ensure the operation is supported.

Member Function Documentation

LocatorInfo::LocatorInfo()

Default constructor.

LocatorInfo::LocatorInfo(const LocatorInfo &other)

Copy constructor from other LocatorInfo.

LocatorInfo::LocatorInfo(LocatorInfo &&other)

Move constructor from other LocatorInfo.

LocatorInfo::~LocatorInfo()

Destructor.

QString LocatorInfo::description() const

Returns the description of the Locator.

QList<LocatorAttribute> LocatorInfo::intersectionResultAttributes() const

Returns the list of LocatorAttribute that will be returned in the GeocodeResult.

bool LocatorInfo::isEmpty() const

Returns whether the Locator is empty.

bool LocatorInfo::isSupportsAddresses() const

Returns whether the Locator supports geocoding by a point or street address.

A point address differs from a street address, as it represents an exact location of a rooftop, versus an interpolated location along a line. If supported, the input search text can be specified as x,y-coordinate pairs, where the spatial reference of the coordinates is WGS84.

bool LocatorInfo::isSupportsIntersections() const

Returns whether the Locator supports geocoding by intersection.

Intersection addresses contain an intersection connector, such as Union St & Carson Rd.

bool LocatorInfo::isSupportsPoi() const

Returns whether the Locator supports geocoding by a place of interest (POI) or landmark.

bool LocatorInfo::isSupportsSuggestions() const

Returns whether the Locator supports generating suggestions for user-input.

QString LocatorInfo::name() const

Returns the name of the Locator.

QVariantMap LocatorInfo::properties() const

Returns the properties of the Locator.

Properties are defined within the locator during creation in ArcMap or ArcGIS Pro. Properties might include MinimumMatchScore, MinimumCandidateScore, or DataSourcePath. These properties can only be viewed in ArcGIS Runtime.

QList<LocatorAttribute> LocatorInfo::resultAttributes() const

Returns the list of LocatorAttribute that will be returned in the GeocodeResult.

QList<LocatorAttribute> LocatorInfo::searchAttributes() const

Returns the list of LocatorAttribute that will be used in the search.

Use this function to determine the attributes that can be used for geocoding with the LocatorTask::geocodeWithSearchValues or LocatorTask::geocodeWithSearchValuesAndParameters

SpatialReference LocatorInfo::spatialReference() const

Returns the SpatialReference of the Locator.

Optionally, a different output spatial reference for a Geocode or Reverse Geocode operation can be set in GeocodeParameters and ReverseGeocodeParameters, respectively.

QString LocatorInfo::version() const

Returns the version of the Locator.

This is the version of the locator itself, and is independent of ArcGIS Runtime, Desktop, and Server.

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

Assignment operator from other LocatorInfo.

LocatorInfo &LocatorInfo::operator=(LocatorInfo &&other)

Move operator from other LocatorInfo.


Feedback on this topic?