Class: CLPlacemark

Inherits:
NSObject show all

Overview

A CLPlacemark object stores placemark data for a given latitude and longitude. Placemark data includes information such as the country, state, city, and street address associated with the specified coordinate. It can also include points of interest and geographically related data. Placemark objects are typically generated by a CLGeocoder object, although you can also create them explicitly yourself.

Direct Known Subclasses

MKPlacemark

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Instance Attribute Details

- (Hash) addressDictionary (readonly)

A dictionary containing the Address Book keys and values for the placemark. (read-only) The keys in this dictionary are those defined by the Address Book framework and used to access address information for a person. For a list of the strings that can be in this dictionary, see the “Address Property” constants in ABPerson Reference.You can format the contents of this dictionary to get a full address string as opposed to building the address yourself. To format the dictionary, use the ABCreateStringWithAddressDictionary function as described in Address Book UI Functions Reference.

Returns:

- (String) administrativeArea (readonly)

The state or province associated with the placemark. (read-only) If the placemark location is Apple’s headquarters, for example, the value for this property would be the string “CA” or “California”.

Returns:

- (Array) areasOfInterest (readonly)

The relevant areas of interest associated with the placemark. (read-only) Examples of an area of interest are the name of a military base or large national park or an attraction such as Eiffel Tower, Disneyland, or Golden Gate Park.

Returns:

- (String) country (readonly)

The name of the country associated with the placemark. (read-only) If the placemark location is Apple’s headquarters, for example, the value for this property would be the string “United States”.

Returns:

- (String) inlandWater (readonly)

The name of the inland water body associated with the placemark. (read-only) For coordinates that lie over an inland body of water, this property contains the name of that water body—the name of a lake, stream, river, or other waterway.

Returns:

- (String) ISOcountryCode (readonly)

The abbreviated country name. (read-only) This string is the standard abbreviation used to refer to the country. For example, if the placemark location is Apple’s headquarters, the value for this property would be the string “US”.

Returns:

- (String) locality (readonly)

The city associated with the placemark. (read-only) If the placemark location is Apple’s headquarters, for example, the value for this property would be the string “Cupertino”.

Returns:

- (CLLocation) location (readonly)

The location object containing latitude and longitude information. (read-only) This object is used to initialize the placemark object.

Returns:

- (String) name (readonly)

The name of the placemark. (read-only)

Returns:

- (String) ocean (readonly)

The name of the ocean associated with the placemark. (read-only) For coordinates that lie over an ocean, this property contains the name of the ocean.

Returns:

- (String) postalCode (readonly)

The postal code associated with the placemark. (read-only) If the placemark location is Apple’s headquarters, for example, the value for this property would be the string “95014”.

Returns:

- (CLRegion) region (readonly)

The geographic region associated with the placemark. (read-only)

Returns:

- (String) subAdministrativeArea (readonly)

Additional administrative area information for the placemark. (read-only) Subadministrative areas typically correspond to counties or other regions that are then organized into a larger administrative area or state. For example, if the placemark location is Apple’s headquarters, the value for this property would be the string “Santa Clara”, which is the county in California that contains the city of Cupertino.

Returns:

- (String) subLocality (readonly)

Additional city-level information for the placemark. (read-only) This property contains additional information, such as the name of the neighborhood or landmark associated with the placemark. It might also refer to a common name that is associated with the location.

Returns:

- (String) subThoroughfare (readonly)

Additional street-level information for the placemark. (read-only) Subthroughfares provide information such as the street number for the location. For example, if the placemark location is Apple’s headquarters (1 Infinite Loop), the value for this property would be the string “1”.

Returns:

- (String) thoroughfare (readonly)

The street address associated with the placemark. (read-only) The street address contains the street name. For example, if the placemark location is Apple’s headquarters, the value for this property would be the string “Infinite Loop”.

Returns:

Instance Method Details

- (Object) initWithPlacemark(placemark)

Initializes and returns a placemark object from another placemark object. You can use this method to transfer information from one placemark object to another placemark object.

Parameters:

  • placemark (CLPlacemark)

    The placemark object to use as the source of the data for the new object.

Returns:

  • (Object)

    A new placemark object.