Public Member Functions | Properties

BMReverseGeocoder Class Reference

BMReverseGeocoder provides context about a latitude/longitude coordinate, such as street address and locality. More...

List of all members.

Public Member Functions

(id) - initWithCoordinate:
 Initializes BMReverseGeocoder with a coordinate.
(void) - start
 Starts an asynchronous reverse geocoding process.
(void) - cancel
 Cancels a previously started reverse geocoding process.
(BOOL) - isQuerying [implementation]
 Inidicates whether BMReverseGeocoder is currently performing a reverse geocoding query. (read-only)

Properties

id< BMReverseGeocoderDelegatedelegate
 The delegate for the reverse geocoder.
CLLocationCoordinate2D coordinate
 The coordinate to be used by the reverse geocoder. (read-only)
BMEntityentity
 The returned entity for the reverse geocoder query containing geocoded results.

Detailed Description

BMReverseGeocoder provides context about a latitude/longitude coordinate, such as street address and locality.

BMReverseGeocoder is typically used in scenarios where it is necessary to show the user a description of a coordinate, such as the user's location.

Reverse geocoded data is returned via the BMReverseGeocoderDelegate which provides a method for accessing the data with a BMEntity and a method called if an error is returned.

The Bing Maps geocoding service is used to provide data for this class. It is possible to reach the transaction limits for this service when called too often. When updating the location's information automatically, create a new request only when a sufficient distance has been travelled. It is worth subscribing to the notification that indicates that the device is locked or in a call in order to prevent further calls when a user is not interacting with the map view.

You can return localized geocoding results by setting Region Format in the International settings menu.


Member Function Documentation

- (void) cancel

Cancels a previously started reverse geocoding process.

This function immediately changes the status of the reverse geocode to cancelled.

- (id) initWithCoordinate: (CLLocationCoordinate2D)  coordinate

Initializes BMReverseGeocoder with a coordinate.

Parameters:
coordinateThe coordinate to use to initialize BMReverseGeocoder.
Returns:
An initialized BMReverseGeocoder object.
- (BOOL) isQuerying [implementation]

Inidicates whether BMReverseGeocoder is currently performing a reverse geocoding query. (read-only)

This property contains YES if the process is on-going or NO if the process is done or has not yet been initiated.

Returns:
Boolean result of whether the reverse geocoder is still querying the Bing Maps reverse geocoding service.
- (void) start

Starts an asynchronous reverse geocoding process.

A BMReverseGeocoder should only be started once.


Property Documentation

- (CLLocationCoordinate2D) coordinate [read, assign]

The coordinate to be used by the reverse geocoder. (read-only)

Returns:
Coordinate to be used by the reverse geocoder.
- (id< BMReverseGeocoderDelegate >) delegate [read, write, assign]

The delegate for the reverse geocoder.

- (BMEntity *) entity [read, assign]

The returned entity for the reverse geocoder query containing geocoded results.

Returns:
Entity containing reverse geocoded results.

The documentation for this class was generated from the following files: