AGSAddressCandidate Class Reference


Description

Instances of this class represent results returned by AGSLocator for geocoding and reverse-geocoding operations. Each result is an address candidate.

Defined in:
AGSLocator.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSAddressCandidate:
<AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithJSON:

Properties

NSDictionary * address
NSString * addressString
NSDictionary * attributes
AGSPointlocation
double score

Member Function Documentation

- (void) decodeWithJSON: (NSDictionary *)  json   [optional, inherited]

Decode object from JSON representation.

Parameters:
json The JSON representation of the object to be decoded.
Since:
1.0
- (NSDictionary *) encodeToJSON   [optional, inherited]

Encode and return JSON representation for object.

Returns:
JSON representation of object.
Since:
1.0
- (id) initWithJSON: (NSDictionary *)  json   [optional, inherited]

Initialize and return object from JSON representation.

Parameters:
json The JSON representation of the object to be created.
Returns:
Object decoded from JSON representation.
Since:
1.0

Property Documentation

- (NSDictionary*) address [read, retain]

Address of the candidate. The dictionary contains a key-value pair for each address field defined by the geocode service. Each address field describes some part of the address information for the candidate.

Since:
1.0
- (NSString*) addressString [read, retain]

A single line address of the candidate, if available.

Since:
1.0
- (NSDictionary*) attributes [read, retain]

A dictionary containing key-value pairs of address field name and value as requested in the returnFields argument of locationsForAddress:returnFields: on AGSLocator.

Since:
1.0
- (AGSPoint*) location [read, retain]

x,y coordinates of the candidate.

Since:
1.0
- (double) score [read, assign]

Numeric score between 0 and 100 for the candidate. A score of 100 means a perfect match, and 0 means no match.

Since:
1.0