deCartaOverlay Class Reference
[Classes for map display and map-related functionality]

A map overlay (a collection of pins). More...

#import <deCartaOverlay.h>

List of all members.

Public Member Functions
(id)	- initWithName:
(int)	- size
(deCartaPin *)	- getAtIndex:
(void)	- addPin:
(void)	- clear
(deCartaPin *)	- removeAtIndex:
(BOOL)	- removePin:
Properties
NSString *	name

---

Detailed Description

A map overlay (a collection of pins).

A collection of pins which are organized into a single map overlay. Use methods of the deCartaMapView class such as deCartaMapView::addOverlay and deCartaMapView::deleteOverlay to add or remove an overlay from the map.

---

Member Function Documentation

- (void) addPin:

(deCartaPin *)

pin

Adds a pin to this overlay.

Parameters:

pin

A deCartaPin object to add to this overlay.

- (void) clear

Removes all pins from the overlay.

- (deCartaPin *) getAtIndex:

(int)

i

Retrieves a specific pin from the overlay.

Parameters:

i

Integer index of the pin to retrieve.

Returns:

A pointer to the deCartaPin object retrieved.

- (id) initWithName:

(NSString *)

name

Creates a deCartaOverlay object with a specified string for a name.

Parameters:

name

Name (string) to assign to the created overlay

Returns:

Objective C ID of the returned deCartaOverlay object

- (deCartaPin *) removeAtIndex:

(int)

i

Removes a specified pin from the overlay, by index

Parameters:

i

Index of the pin to remove

Returns:

A pointer to the deCartaPin object removed from the overlay.

- (BOOL) removePin:

(deCartaPin *)

pin

Removes a specified pin from the overlay, by pointer

Parameters:

pin

A pointer to a deCartaPin object to remove

Returns:

TRUE if the pin was successfully removed, FALSE if an error occurred

- (int) size

Returns the number of pins stored in this overlay

Returns:

integer number of pins in the overlay

---

Property Documentation

- (NSString*) name [read, retain]

A name for this deCartaOverlay object

---

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

• D:/decarta_projects/export08122011/iPhoneV2/iPhoneAPI/map/deCartaOverlay.h
• D:/decarta_projects/export08122011/iPhoneV2/iPhoneAPI/map/deCartaOverlay.m